public static final class StructuredQuery.CollectionSelector extends GeneratedMessageV3 implements StructuredQuery.CollectionSelectorOrBuilder
A selection of a collection, such as messages as m1
.
Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > StructuredQuery.CollectionSelectorImplements
StructuredQuery.CollectionSelectorOrBuilderStatic Fields
ALL_DESCENDANTS_FIELD_NUMBER
public static final int ALL_DESCENDANTS_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
COLLECTION_ID_FIELD_NUMBER
public static final int COLLECTION_ID_FIELD_NUMBER
Field Value | |
---|---|
Type | Description |
int |
Static Methods
getDefaultInstance()
public static StructuredQuery.CollectionSelector getDefaultInstance()
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
newBuilder()
public static StructuredQuery.CollectionSelector.Builder newBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector.Builder |
newBuilder(StructuredQuery.CollectionSelector prototype)
public static StructuredQuery.CollectionSelector.Builder newBuilder(StructuredQuery.CollectionSelector prototype)
Parameter | |
---|---|
Name | Description |
prototype | StructuredQuery.CollectionSelector |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector.Builder |
parseDelimitedFrom(InputStream input)
public static StructuredQuery.CollectionSelector parseDelimitedFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(byte[] data)
public static StructuredQuery.CollectionSelector parseFrom(byte[] data)
Parameter | |
---|---|
Name | Description |
data | byte[] |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data)
public static StructuredQuery.CollectionSelector parseFrom(ByteString data)
Parameter | |
---|---|
Name | Description |
data | ByteString |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(CodedInputStream input)
public static StructuredQuery.CollectionSelector parseFrom(CodedInputStream input)
Parameter | |
---|---|
Name | Description |
input | CodedInputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input)
public static StructuredQuery.CollectionSelector parseFrom(InputStream input)
Parameter | |
---|---|
Name | Description |
input | InputStream |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
IOException |
parseFrom(ByteBuffer data)
public static StructuredQuery.CollectionSelector parseFrom(ByteBuffer data)
Parameter | |
---|---|
Name | Description |
data | ByteBuffer |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static StructuredQuery.CollectionSelector parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
Exceptions | |
---|---|
Type | Description |
InvalidProtocolBufferException |
parser()
public static Parser<StructuredQuery.CollectionSelector> parser()
Returns | |
---|---|
Type | Description |
Parser<CollectionSelector> |
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter | |
---|---|
Name | Description |
obj | Object |
Returns | |
---|---|
Type | Description |
boolean |
getAllDescendants()
public boolean getAllDescendants()
When false, selects only collections that are immediate children of
the parent
specified in the containing RunQueryRequest
.
When true, selects all descendant collections.
bool all_descendants = 3;
Returns | |
---|---|
Type | Description |
boolean | The allDescendants. |
getCollectionId()
public String getCollectionId()
The collection ID. When set, selects only collections with this ID.
string collection_id = 2;
Returns | |
---|---|
Type | Description |
String | The collectionId. |
getCollectionIdBytes()
public ByteString getCollectionIdBytes()
The collection ID. When set, selects only collections with this ID.
string collection_id = 2;
Returns | |
---|---|
Type | Description |
ByteString | The bytes for collectionId. |
getDefaultInstanceForType()
public StructuredQuery.CollectionSelector getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector |
getParserForType()
public Parser<StructuredQuery.CollectionSelector> getParserForType()
Returns | |
---|---|
Type | Description |
Parser<CollectionSelector> |
getSerializedSize()
public int getSerializedSize()
Returns | |
---|---|
Type | Description |
int |
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns | |
---|---|
Type | Description |
UnknownFieldSet |
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.CollectionSelector.Builder newBuilderForType()
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector.Builder |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected StructuredQuery.CollectionSelector.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter | |
---|---|
Name | Description |
parent | BuilderParent |
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector.Builder |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter | |
---|---|
Name | Description |
unused | UnusedPrivateParameter |
Returns | |
---|---|
Type | Description |
Object |
toBuilder()
public StructuredQuery.CollectionSelector.Builder toBuilder()
Returns | |
---|---|
Type | Description |
StructuredQuery.CollectionSelector.Builder |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter | |
---|---|
Name | Description |
output | CodedOutputStream |
Exceptions | |
---|---|
Type | Description |
IOException |