Class | Description |
---|---|
CollectionGroupName | |
CollectionGroupName.Builder |
Builder for projects/{project}/databases/{database}/collectionGroups/{collection}.
|
CreateIndexRequest |
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
|
CreateIndexRequest.Builder |
The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
|
Database |
A Cloud Firestore Database.
|
Database.Builder |
A Cloud Firestore Database.
|
DatabaseName | |
DatabaseName.Builder |
Builder for projects/{project}/databases/{database}.
|
DatabaseProto | |
DeleteIndexRequest |
The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
|
DeleteIndexRequest.Builder |
The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].
|
ExportDocumentsMetadata |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
|
ExportDocumentsMetadata.Builder |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
|
ExportDocumentsRequest |
The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
|
ExportDocumentsRequest.Builder |
The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].
|
ExportDocumentsResponse |
Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
|
ExportDocumentsResponse.Builder |
Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.
|
Field |
Represents a single field in the database.
|
Field.Builder |
Represents a single field in the database.
|
Field.IndexConfig |
The index configuration for this field.
|
Field.IndexConfig.Builder |
The index configuration for this field.
|
Field.TtlConfig |
The TTL (time-to-live) configuration for documents that have this `Field`
set.
|
Field.TtlConfig.Builder |
The TTL (time-to-live) configuration for documents that have this `Field`
set.
|
FieldName | |
FieldName.Builder |
Builder for
projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}.
|
FieldOperationMetadata |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
|
FieldOperationMetadata.Builder |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
|
FieldOperationMetadata.IndexConfigDelta |
Information about an index configuration change.
|
FieldOperationMetadata.IndexConfigDelta.Builder |
Information about an index configuration change.
|
FieldOperationMetadata.TtlConfigDelta |
Information about an TTL configuration change.
|
FieldOperationMetadata.TtlConfigDelta.Builder |
Information about an TTL configuration change.
|
FieldProto | |
FirestoreAdminGrpc |
The Cloud Firestore Admin API.
|
FirestoreAdminGrpc.FirestoreAdminBlockingStub |
A stub to allow clients to do synchronous rpc calls to service FirestoreAdmin.
|
FirestoreAdminGrpc.FirestoreAdminFutureStub |
A stub to allow clients to do ListenableFuture-style rpc calls to service FirestoreAdmin.
|
FirestoreAdminGrpc.FirestoreAdminImplBase |
Base class for the server implementation of the service FirestoreAdmin.
|
FirestoreAdminGrpc.FirestoreAdminStub |
A stub to allow clients to do asynchronous rpc calls to service FirestoreAdmin.
|
FirestoreAdminProto | |
GetDatabaseRequest |
The request for [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].
|
GetDatabaseRequest.Builder |
The request for [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].
|
GetFieldRequest |
The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
|
GetFieldRequest.Builder |
The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].
|
GetIndexRequest |
The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
|
GetIndexRequest.Builder |
The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].
|
ImportDocumentsMetadata |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
|
ImportDocumentsMetadata.Builder |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
|
ImportDocumentsRequest |
The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
|
ImportDocumentsRequest.Builder |
The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].
|
Index |
Cloud Firestore indexes enable simple and complex queries against
documents in a database.
|
Index.Builder |
Cloud Firestore indexes enable simple and complex queries against
documents in a database.
|
Index.IndexField |
A field in an index.
|
Index.IndexField.Builder |
A field in an index.
|
IndexName | |
IndexName.Builder |
Builder for
projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}.
|
IndexOperationMetadata |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
|
IndexOperationMetadata.Builder |
Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from
[FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].
|
IndexProto | |
ListDatabasesRequest |
A request to list the Firestore Databases in all locations for a project.
|
ListDatabasesRequest.Builder |
A request to list the Firestore Databases in all locations for a project.
|
ListDatabasesResponse |
The list of databases for a project.
|
ListDatabasesResponse.Builder |
The list of databases for a project.
|
ListFieldsRequest |
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
|
ListFieldsRequest.Builder |
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
|
ListFieldsResponse |
The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
|
ListFieldsResponse.Builder |
The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
|
ListIndexesRequest |
The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
|
ListIndexesRequest.Builder |
The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
|
ListIndexesResponse |
The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
|
ListIndexesResponse.Builder |
The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].
|
LocationMetadata |
The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
|
LocationMetadata.Builder |
The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].
|
LocationProto | |
OperationProto | |
ParentName |
AUTO-GENERATED DOCUMENTATION AND CLASS
|
ParentName.Builder |
Builder for ParentName.
|
Progress |
Describes the progress of the operation.
|
Progress.Builder |
Describes the progress of the operation.
|
ProjectName | |
ProjectName.Builder |
Builder for projects/{project}.
|
UpdateDatabaseMetadata |
Metadata related to the update database operation.
|
UpdateDatabaseMetadata.Builder |
Metadata related to the update database operation.
|
UpdateDatabaseRequest |
The request for [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].
|
UpdateDatabaseRequest.Builder |
The request for [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].
|
UpdateFieldRequest |
The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
|
UpdateFieldRequest.Builder |
The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].
|
Enum | Description |
---|---|
Database.AppEngineIntegrationMode |
The type of App Engine integration mode.
|
Database.ConcurrencyMode |
The type of concurrency control mode for transactions.
|
Database.DatabaseType |
The type of the database.
|
Field.TtlConfig.State |
The state of applying the TTL configuration to all documents.
|
FieldOperationMetadata.IndexConfigDelta.ChangeType |
Specifies how the index is changing.
|
FieldOperationMetadata.TtlConfigDelta.ChangeType |
Specifies how the TTL config is changing.
|
Index.ApiScope |
API Scope defines the APIs (Firestore Native, or Firestore in
Datastore Mode) that are supported for queries.
|
Index.IndexField.ArrayConfig |
The supported array value configurations.
|
Index.IndexField.Order |
The supported orderings.
|
Index.IndexField.ValueModeCase | |
Index.QueryScope |
Query Scope defines the scope at which a query is run.
|
Index.State |
The state of an index.
|
OperationState |
Describes the state of the operation.
|
Copyright © 2023 Google LLC. All rights reserved.