Enum Index.Density (3.31.3) 

public enum Index.Density extends Enum<Index.Density> implements ProtocolMessageEnum

The density configuration for the index.

Protobuf enum google.firestore.admin.v1.Index.Density

Implements

ProtocolMessageEnum

Static Fields

Name Description
DENSE

An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.

DENSE = 3;
DENSE_VALUE

An index entry will be added regardless of whether the document contains any of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.

DENSE = 3;
DENSITY_UNSPECIFIED

Unspecified. It will use database default setting. This value is input only.

DENSITY_UNSPECIFIED = 0;
DENSITY_UNSPECIFIED_VALUE

Unspecified. It will use database default setting. This value is input only.

DENSITY_UNSPECIFIED = 0;
SPARSE_ALL

In order for an index entry to be added, the document must contain all fields specified in the index.

This is the only allowed value for indexes having ApiScope ANY_API and DATASTORE_MODE_API.

SPARSE_ALL = 1;
SPARSE_ALL_VALUE

In order for an index entry to be added, the document must contain all fields specified in the index.

This is the only allowed value for indexes having ApiScope ANY_API and DATASTORE_MODE_API.

SPARSE_ALL = 1;
SPARSE_ANY

In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.

SPARSE_ANY = 2;
SPARSE_ANY_VALUE

In order for an index entry to be added, the document must contain at least one of the fields specified in the index. Non-existent fields are treated as having a NULL value when generating index entries.

SPARSE_ANY = 2;
UNRECOGNIZED

Static Methods

Name Description
forNumber(int value)
getDescriptor()
internalGetValueMap()
valueOf(Descriptors.EnumValueDescriptor desc)
valueOf(int value)

Deprecated. Use #forNumber(int) instead.
valueOf(String name)
values()

Methods

Name Description
getDescriptorForType()
getNumber()
getValueDescriptor()