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.FieldReferenceImplements
StructuredQuery.FieldReferenceOrBuilderStatic Fields
FIELD_PATH_FIELD_NUMBER
public static final int FIELD_PATH_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static StructuredQuery.FieldReference getDefaultInstance()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static StructuredQuery.FieldReference.Builder newBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
newBuilder(StructuredQuery.FieldReference prototype)
public static StructuredQuery.FieldReference.Builder newBuilder(StructuredQuery.FieldReference prototype)
Parameter | |
---|---|
Name | Description |
prototype |
StructuredQuery.FieldReference |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
parseDelimitedFrom(InputStream input)
public static StructuredQuery.FieldReference parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static StructuredQuery.FieldReference parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data |
byte[] |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static StructuredQuery.FieldReference parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data |
ByteString |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static StructuredQuery.FieldReference parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input |
CodedInputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static StructuredQuery.FieldReference parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input |
InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static StructuredQuery.FieldReference parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data |
ByteBuffer |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.FieldReference parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<StructuredQuery.FieldReference> parser()
Returns | |
---|---|
Type | Description |
Parser<FieldReference> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj |
Object |
Returns | |
---|---|
Type | Description |
boolean |
getDefaultInstanceForType()
public StructuredQuery.FieldReference getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference |
getFieldPath()
public String getFieldPath()
A reference to a field in a document.
Requires:
- MUST be a dot-delimited (
.
) string of segments, where each segment conforms to document field name limitations.
string field_path = 2;
Returns | |
---|---|
Type | Description |
String |
The fieldPath. |
getFieldPathBytes()
public ByteString getFieldPathBytes()
A reference to a field in a document.
Requires:
- MUST be a dot-delimited (
.
) string of segments, where each segment conforms to document field name limitations.
string field_path = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for fieldPath. |
getParserForType()
public Parser<StructuredQuery.FieldReference> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<FieldReference> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
hashCode()
public int hashCode()
Returns | |
---|---|
Type | Description |
int |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
newBuilderForType()
public StructuredQuery.FieldReference.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredQuery.FieldReference.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent |
BuilderParent |
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused |
UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public StructuredQuery.FieldReference.Builder toBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.FieldReference.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output |
CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |