Package com.google.firestore.admin.v1

Interface IndexOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Index, Index.Builder
@Generated public interface IndexOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       Output only. A server defined name for this index.
 The form of this name for composite indexes will be:
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`
 For single field indexes, this field will be empty.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. A server defined name for this index.
 The form of this name for composite indexes will be:
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}`
 For single field indexes, this field will be empty.
      string name = 1;
      Returns:
      The bytes for name.

    • getQueryScopeValue

      int getQueryScopeValue()
       Indexes with a collection query scope specified allow queries
 against a collection that is the child of a specific document, specified at
 query time, and that has the same collection ID.

 Indexes with a collection group query scope specified allow queries against
 all collections descended from a specific document, specified at query
 time, and that have the same collection ID as this index.
      .google.firestore.admin.v1.Index.QueryScope query_scope = 2;
      Returns:
      The enum numeric value on the wire for queryScope.

    • getQueryScope

      Index.QueryScope getQueryScope()
       Indexes with a collection query scope specified allow queries
 against a collection that is the child of a specific document, specified at
 query time, and that has the same collection ID.

 Indexes with a collection group query scope specified allow queries against
 all collections descended from a specific document, specified at query
 time, and that have the same collection ID as this index.
      .google.firestore.admin.v1.Index.QueryScope query_scope = 2;
      Returns:
      The queryScope.

    • getApiScopeValue

      int getApiScopeValue()
       The API scope supported by this index.
      .google.firestore.admin.v1.Index.ApiScope api_scope = 5;
      Returns:
      The enum numeric value on the wire for apiScope.

    • getApiScope

      Index.ApiScope getApiScope()
       The API scope supported by this index.
      .google.firestore.admin.v1.Index.ApiScope api_scope = 5;
      Returns:
      The apiScope.

    • getFieldsList

      List<Index.IndexField> getFieldsList()
       The fields supported by this index.

 For composite indexes, this requires a minimum of 2 and a maximum of 100
 fields. The last field entry is always for the field path `__name__`. If,
 on creation, `__name__` was not specified as the last field, it will be
 added automatically with the same direction as that of the last field
 defined. If the final field in a composite index is not directional, the
 `__name__` will be ordered ASCENDING (unless explicitly specified).

 For single field indexes, this will always be exactly one entry with a
 field path equal to the field path of the associated field.
      repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

    • getFields

      Index.IndexField getFields(int index)
       The fields supported by this index.

 For composite indexes, this requires a minimum of 2 and a maximum of 100
 fields. The last field entry is always for the field path `__name__`. If,
 on creation, `__name__` was not specified as the last field, it will be
 added automatically with the same direction as that of the last field
 defined. If the final field in a composite index is not directional, the
 `__name__` will be ordered ASCENDING (unless explicitly specified).

 For single field indexes, this will always be exactly one entry with a
 field path equal to the field path of the associated field.
      repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

    • getFieldsCount

      int getFieldsCount()
       The fields supported by this index.

 For composite indexes, this requires a minimum of 2 and a maximum of 100
 fields. The last field entry is always for the field path `__name__`. If,
 on creation, `__name__` was not specified as the last field, it will be
 added automatically with the same direction as that of the last field
 defined. If the final field in a composite index is not directional, the
 `__name__` will be ordered ASCENDING (unless explicitly specified).

 For single field indexes, this will always be exactly one entry with a
 field path equal to the field path of the associated field.
      repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

    • getFieldsOrBuilderList

      List<? extends Index.IndexFieldOrBuilder> getFieldsOrBuilderList()
       The fields supported by this index.

 For composite indexes, this requires a minimum of 2 and a maximum of 100
 fields. The last field entry is always for the field path `__name__`. If,
 on creation, `__name__` was not specified as the last field, it will be
 added automatically with the same direction as that of the last field
 defined. If the final field in a composite index is not directional, the
 `__name__` will be ordered ASCENDING (unless explicitly specified).

 For single field indexes, this will always be exactly one entry with a
 field path equal to the field path of the associated field.
      repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

    • getFieldsOrBuilder

      Index.IndexFieldOrBuilder getFieldsOrBuilder(int index)
       The fields supported by this index.

 For composite indexes, this requires a minimum of 2 and a maximum of 100
 fields. The last field entry is always for the field path `__name__`. If,
 on creation, `__name__` was not specified as the last field, it will be
 added automatically with the same direction as that of the last field
 defined. If the final field in a composite index is not directional, the
 `__name__` will be ordered ASCENDING (unless explicitly specified).

 For single field indexes, this will always be exactly one entry with a
 field path equal to the field path of the associated field.
      repeated .google.firestore.admin.v1.Index.IndexField fields = 3;

    • getStateValue

      int getStateValue()
       Output only. The serving state of the index.
      .google.firestore.admin.v1.Index.State state = 4;
      Returns:
      The enum numeric value on the wire for state.

    • getState

      Index.State getState()
       Output only. The serving state of the index.
      .google.firestore.admin.v1.Index.State state = 4;
      Returns:
      The state.

    • getDensityValue

      int getDensityValue()
       Immutable. The density configuration of the index.
      .google.firestore.admin.v1.Index.Density density = 6 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The enum numeric value on the wire for density.

    • getDensity

      Index.Density getDensity()
       Immutable. The density configuration of the index.
      .google.firestore.admin.v1.Index.Density density = 6 [(.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The density.

    • getMultikey

      boolean getMultikey()
       Optional. Whether the index is multikey. By default, the index is not
 multikey. For non-multikey indexes, none of the paths in the index
 definition reach or traverse an array, except via an explicit array index.
 For multikey indexes, at most one of the paths in the index definition
 reach or traverse an array, except via an explicit array index. Violations
 will result in errors.

 Note this field only applies to index with MONGODB_COMPATIBLE_API ApiScope.
      bool multikey = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The multikey.

    • getShardCount

      int getShardCount()
       Optional. The number of shards for the index.
      int32 shard_count = 8 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The shardCount.

    • getUnique

      boolean getUnique()
       Optional. Whether it is an unique index. Unique index ensures all values
 for the indexed field(s) are unique across documents.
      bool unique = 10 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The unique.