Class Schema.SchemaField (1.46.0)

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

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()
Returns
Type Description
Schema.SchemaField

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Schema.SchemaField.Builder newBuilder()
Returns
Type Description
Schema.SchemaField.Builder

newBuilder(Schema.SchemaField prototype)

public static Schema.SchemaField.Builder newBuilder(Schema.SchemaField prototype)
Parameter
Name Description
prototype Schema.SchemaField
Returns
Type Description
Schema.SchemaField.Builder

parseDelimitedFrom(InputStream input)

public static Schema.SchemaField parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Schema.SchemaField parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Schema.SchemaField parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Schema.SchemaField parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Schema.SchemaField parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Schema.SchemaField parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Schema.SchemaField parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Schema.SchemaField
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Schema.SchemaField> parser()
Returns
Type Description
Parser<SchemaField>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Schema.SchemaField getDefaultInstanceForType()
Returns
Type Description
Schema.SchemaField

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
index int
Returns
Type Description
Schema.SchemaField

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

Returns
Type Description
List<SchemaField>

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
index int
Returns
Type Description
Schema.SchemaFieldOrBuilder

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

Returns
Type Description
Schema.Mode

The mode.

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()

public String 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()
Returns
Type Description
Parser<SchemaField>
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];

Returns
Type Description
Schema.Type

The type.

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Schema.SchemaField.Builder newBuilderForType()
Returns
Type Description
Schema.SchemaField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Schema.SchemaField.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Schema.SchemaField.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Schema.SchemaField.Builder toBuilder()
Returns
Type Description
Schema.SchemaField.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException