Class Schema.SchemaField (1.28.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
TypeDescription
int

FIELDS_FIELD_NUMBER

public static final int FIELDS_FIELD_NUMBER
Field Value
TypeDescription
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_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 Schema.SchemaField getDefaultInstance()
Returns
TypeDescription
Schema.SchemaField

getDescriptor()

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

newBuilder()

public static Schema.SchemaField.Builder newBuilder()
Returns
TypeDescription
Schema.SchemaField.Builder

newBuilder(Schema.SchemaField prototype)

public static Schema.SchemaField.Builder newBuilder(Schema.SchemaField prototype)
Parameter
NameDescription
prototypeSchema.SchemaField
Returns
TypeDescription
Schema.SchemaField.Builder

parseDelimitedFrom(InputStream input)

public static Schema.SchemaField parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schema.SchemaField
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Schema.SchemaField parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Schema.SchemaField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Schema.SchemaField parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Schema.SchemaField
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Schema.SchemaField parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Schema.SchemaField
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Schema.SchemaField parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Schema.SchemaField
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Schema.SchemaField getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Schema.SchemaField> getParserForType()
Returns
TypeDescription
Parser<SchemaField>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for type.

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 Schema.SchemaField.Builder newBuilderForType()
Returns
TypeDescription
Schema.SchemaField.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Schema.SchemaField.Builder toBuilder()
Returns
TypeDescription
Schema.SchemaField.Builder

writeTo(CodedOutputStream output)

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