Class StructType.Field (6.72.0)

public static final class StructType.Field extends GeneratedMessageV3 implements StructType.FieldOrBuilder

Message representing a single field of a struct.

Protobuf type google.spanner.v1.StructType.Field

Static Fields

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 StructType.Field getDefaultInstance()
Returns
Type Description
StructType.Field

getDescriptor()

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

newBuilder()

public static StructType.Field.Builder newBuilder()
Returns
Type Description
StructType.Field.Builder

newBuilder(StructType.Field prototype)

public static StructType.Field.Builder newBuilder(StructType.Field prototype)
Parameter
Name Description
prototype StructType.Field
Returns
Type Description
StructType.Field.Builder

parseDelimitedFrom(InputStream input)

public static StructType.Field parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructType.Field
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static StructType.Field parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
StructType.Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static StructType.Field parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
StructType.Field
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static StructType.Field parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
StructType.Field
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static StructType.Field parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
StructType.Field
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<StructType.Field> parser()
Returns
Type Description
Parser<Field>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StructType.Field getDefaultInstanceForType()
Returns
Type Description
StructType.Field

getName()

public String getName()

The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., "Word" in the query "SELECT 'hello' AS Word"), or the column name (e.g., "ColName" in the query "SELECT ColName FROM Table"). Some columns might have an empty name (e.g., "SELECT UPPER(ColName)"). Note that a query result can contain multiple fields with the same name.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the field. For reads, this is the column name. For SQL queries, it is the column alias (e.g., "Word" in the query "SELECT 'hello' AS Word"), or the column name (e.g., "ColName" in the query "SELECT ColName FROM Table"). Some columns might have an empty name (e.g., "SELECT UPPER(ColName)"). Note that a query result can contain multiple fields with the same name.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<StructType.Field> getParserForType()
Returns
Type Description
Parser<Field>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public Type getType()

The type of the field.

.google.spanner.v1.Type type = 2;

Returns
Type Description
Type

The type.

getTypeOrBuilder()

public TypeOrBuilder getTypeOrBuilder()

The type of the field.

.google.spanner.v1.Type type = 2;

Returns
Type Description
TypeOrBuilder

hasType()

public boolean hasType()

The type of the field.

.google.spanner.v1.Type type = 2;

Returns
Type Description
boolean

Whether the type field is set.

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 StructType.Field.Builder newBuilderForType()
Returns
Type Description
StructType.Field.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructType.Field.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
StructType.Field.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StructType.Field.Builder toBuilder()
Returns
Type Description
StructType.Field.Builder

writeTo(CodedOutputStream output)

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