Class StructuredQuery.FieldReference (3.5.0)

Stay organized with collections Save and categorize content based on your preferences.
public static final class StructuredQuery.FieldReference extends GeneratedMessageV3 implements StructuredQuery.FieldReferenceOrBuilder

A reference to a field in a document, ex: stats.operations.

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredQuery.FieldReference

Static Fields

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static StructuredQuery.FieldReference getDefaultInstance()
Returns
TypeDescription
StructuredQuery.FieldReference

getDescriptor()

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

newBuilder()

public static StructuredQuery.FieldReference.Builder newBuilder()
Returns
TypeDescription
StructuredQuery.FieldReference.Builder

newBuilder(StructuredQuery.FieldReference prototype)

public static StructuredQuery.FieldReference.Builder newBuilder(StructuredQuery.FieldReference prototype)
Parameter
NameDescription
prototypeStructuredQuery.FieldReference
Returns
TypeDescription
StructuredQuery.FieldReference.Builder

parseDelimitedFrom(InputStream input)

public static StructuredQuery.FieldReference parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredQuery.FieldReference
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static StructuredQuery.FieldReference parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
StructuredQuery.FieldReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static StructuredQuery.FieldReference parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
StructuredQuery.FieldReference
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static StructuredQuery.FieldReference parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
StructuredQuery.FieldReference
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static StructuredQuery.FieldReference parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
StructuredQuery.FieldReference
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<StructuredQuery.FieldReference> parser()
Returns
TypeDescription
Parser<FieldReference>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public StructuredQuery.FieldReference getDefaultInstanceForType()
Returns
TypeDescription
StructuredQuery.FieldReference

getFieldPath()

public String getFieldPath()

The relative path of the document being referenced. Requires:

  • Conform to document field name limitations.

string field_path = 2;

Returns
TypeDescription
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

The relative path of the document being referenced. Requires:

  • Conform to document field name limitations.

string field_path = 2;

Returns
TypeDescription
ByteString

The bytes for fieldPath.

getParserForType()

public Parser<StructuredQuery.FieldReference> getParserForType()
Returns
TypeDescription
Parser<FieldReference>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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 StructuredQuery.FieldReference.Builder newBuilderForType()
Returns
TypeDescription
StructuredQuery.FieldReference.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected StructuredQuery.FieldReference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
StructuredQuery.FieldReference.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public StructuredQuery.FieldReference.Builder toBuilder()
Returns
TypeDescription
StructuredQuery.FieldReference.Builder

writeTo(CodedOutputStream output)

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