Cloud Firestore V1 Client - Class ApiScope (1.46.0)

Version 1.46.0

• 1.47.0 (latest)
• 1.46.0
• 1.45.2
• 1.44.1
• 1.43.3
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.7
• 1.36.1
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.28.0
• 1.27.3

Reference documentation and code samples for the Cloud Firestore V1 Client class ApiScope.

API Scope defines the APIs (Firestore Native, or Firestore in Datastore Mode) that are supported for queries.

Protobuf type google.firestore.admin.v1.Index.ApiScope

Namespace

Google \ Cloud \ Firestore \ Admin \ V1 \ Index

Methods

static::name

Parameter
Name	Description
value	mixed

static::value

Parameter
Name	Description
name	mixed

Constants

ANY_API

Value: 0

The index can only be used by the Firestore Native query API.

This is the default.

Generated from protobuf enum ANY_API = 0;

DATASTORE_MODE_API

Value: 1

The index can only be used by the Firestore in Datastore Mode query API.

Generated from protobuf enum DATASTORE_MODE_API = 1;