Class StructuredQuery.CollectionSelector.Builder (3.21.1)

public static final class StructuredQuery.CollectionSelector.Builder extends GeneratedMessageV3.Builder<StructuredQuery.CollectionSelector.Builder> implements StructuredQuery.CollectionSelectorOrBuilder

A selection of a collection, such as messages as m1.

Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.CollectionSelector.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

build()

public StructuredQuery.CollectionSelector build()
Returns
Type Description
StructuredQuery.CollectionSelector

buildPartial()

public StructuredQuery.CollectionSelector buildPartial()
Returns
Type Description
StructuredQuery.CollectionSelector

clear()

public StructuredQuery.CollectionSelector.Builder clear()
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

clearAllDescendants()

public StructuredQuery.CollectionSelector.Builder clearAllDescendants()

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
StructuredQuery.CollectionSelector.Builder

This builder for chaining.

clearCollectionId()

public StructuredQuery.CollectionSelector.Builder clearCollectionId()

The collection ID. When set, selects only collections with this ID.

string collection_id = 2;

Returns
Type Description
StructuredQuery.CollectionSelector.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public StructuredQuery.CollectionSelector.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public StructuredQuery.CollectionSelector.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

clone()

public StructuredQuery.CollectionSelector.Builder clone()
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(StructuredQuery.CollectionSelector other)

public StructuredQuery.CollectionSelector.Builder mergeFrom(StructuredQuery.CollectionSelector other)
Parameter
Name Description
other StructuredQuery.CollectionSelector
Returns
Type Description
StructuredQuery.CollectionSelector.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public StructuredQuery.CollectionSelector.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public StructuredQuery.CollectionSelector.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.CollectionSelector.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

setAllDescendants(boolean value)

public StructuredQuery.CollectionSelector.Builder setAllDescendants(boolean value)

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;

Parameter
Name Description
value boolean

The allDescendants to set.

Returns
Type Description
StructuredQuery.CollectionSelector.Builder

This builder for chaining.

setCollectionId(String value)

public StructuredQuery.CollectionSelector.Builder setCollectionId(String value)

The collection ID. When set, selects only collections with this ID.

string collection_id = 2;

Parameter
Name Description
value String

The collectionId to set.

Returns
Type Description
StructuredQuery.CollectionSelector.Builder

This builder for chaining.

setCollectionIdBytes(ByteString value)

public StructuredQuery.CollectionSelector.Builder setCollectionIdBytes(ByteString value)

The collection ID. When set, selects only collections with this ID.

string collection_id = 2;

Parameter
Name Description
value ByteString

The bytes for collectionId to set.

Returns
Type Description
StructuredQuery.CollectionSelector.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public StructuredQuery.CollectionSelector.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public StructuredQuery.CollectionSelector.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final StructuredQuery.CollectionSelector.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
StructuredQuery.CollectionSelector.Builder
Overrides