public class FirestoreAdminClient : ClientBase<FirestoreAdmin.FirestoreAdminClient>Client for FirestoreAdmin
Inheritance
Object > ClientBase > ClientBase<FirestoreAdmin.FirestoreAdminClient> > FirestoreAdmin.FirestoreAdminClientNamespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Constructors
FirestoreAdminClient()
protected FirestoreAdminClient()Protected parameterless constructor to allow creation of test doubles.
FirestoreAdminClient(CallInvoker)
public FirestoreAdminClient(CallInvoker callInvoker)Creates a new client for FirestoreAdmin that uses a custom CallInvoker.
| Parameter | |
|---|---|
| Name | Description |
callInvoker | CallInvokerThe callInvoker to use to make remote calls. |
FirestoreAdminClient(Channel)
[Obsolete("This constructor overload is present for compatibility only, and will be removed in the next major version")]
public FirestoreAdminClient(Channel channel)Creates a new client using a channel.
| Parameter | |
|---|---|
| Name | Description |
channel | Grpc.Core.ChannelThe channel to use to make remote calls. |
FirestoreAdminClient(ChannelBase)
public FirestoreAdminClient(ChannelBase channel)Creates a new client for FirestoreAdmin
| Parameter | |
|---|---|
| Name | Description |
channel | ChannelBaseThe channel to use to make remote calls. |
FirestoreAdminClient(ClientBase.ClientBaseConfiguration)
protected FirestoreAdminClient(ClientBase.ClientBaseConfiguration configuration)Protected constructor to allow creation of configured clients.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBase.ClientBaseConfigurationThe client configuration. |
Methods
CreateIndex(CreateIndexRequest, CallOptions)
public virtual Operation CreateIndex(CreateIndexRequest request, CallOptions options)Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
| Parameters | |
|---|---|
| Name | Description |
request | CreateIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
CreateIndex(CreateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation CreateIndex(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
| Parameters | |
|---|---|
| Name | Description |
request | CreateIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
CreateIndexAsync(CreateIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, CallOptions options)Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
| Parameters | |
|---|---|
| Name | Description |
request | CreateIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateIndexAsync(CreateIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].
| Parameters | |
|---|---|
| Name | Description |
request | CreateIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
CreateOperationsClient()
public virtual Operations.OperationsClient CreateOperationsClient()Creates a new instance of Operations.OperationsClient using the same call invoker as this client.
| Returns | |
|---|---|
| Type | Description |
Operations.OperationsClient | A new Operations client for the same target as this client. |
DeleteIndex(DeleteIndexRequest, CallOptions)
public virtual Empty DeleteIndex(DeleteIndexRequest request, CallOptions options)Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DeleteIndex(DeleteIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Empty DeleteIndex(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Empty | The response received from the server. |
DeleteIndexAsync(DeleteIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Empty> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> | The call object. |
DeleteIndexAsync(DeleteIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Empty> DeleteIndexAsync(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Empty> | The call object. |
ExportDocuments(ExportDocumentsRequest, CallOptions)
public virtual Operation ExportDocuments(ExportDocumentsRequest request, CallOptions options)Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ExportDocuments(ExportDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation ExportDocuments(ExportDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ExportDocumentsAsync(ExportDocumentsRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ExportDocumentsAsync(ExportDocumentsRequest request, CallOptions options)Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
ExportDocumentsAsync(ExportDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> ExportDocumentsAsync(ExportDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
GetDatabase(GetDatabaseRequest, CallOptions)
public virtual Database GetDatabase(GetDatabaseRequest request, CallOptions options)Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Database | The response received from the server. |
GetDatabase(GetDatabaseRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Database GetDatabase(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Database | The response received from the server. |
GetDatabaseAsync(GetDatabaseRequest, CallOptions)
public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, CallOptions options)Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Database> | The call object. |
GetDatabaseAsync(GetDatabaseRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Database> | The call object. |
GetField(GetFieldRequest, CallOptions)
public virtual Field GetField(GetFieldRequest request, CallOptions options)Gets the metadata and configuration for a Field.
| Parameters | |
|---|---|
| Name | Description |
request | GetFieldRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Field | The response received from the server. |
GetField(GetFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Field GetField(GetFieldRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets the metadata and configuration for a Field.
| Parameters | |
|---|---|
| Name | Description |
request | GetFieldRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Field | The response received from the server. |
GetFieldAsync(GetFieldRequest, CallOptions)
public virtual AsyncUnaryCall<Field> GetFieldAsync(GetFieldRequest request, CallOptions options)Gets the metadata and configuration for a Field.
| Parameters | |
|---|---|
| Name | Description |
request | GetFieldRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Field> | The call object. |
GetFieldAsync(GetFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Field> GetFieldAsync(GetFieldRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets the metadata and configuration for a Field.
| Parameters | |
|---|---|
| Name | Description |
request | GetFieldRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Field> | The call object. |
GetIndex(GetIndexRequest, CallOptions)
public virtual Index GetIndex(GetIndexRequest request, CallOptions options)Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Index | The response received from the server. |
GetIndex(GetIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Index GetIndex(GetIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Index | The response received from the server. |
GetIndexAsync(GetIndexRequest, CallOptions)
public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Index> | The call object. |
GetIndexAsync(GetIndexRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Index> | The call object. |
ImportDocuments(ImportDocumentsRequest, CallOptions)
public virtual Operation ImportDocuments(ImportDocumentsRequest request, CallOptions options)Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ImportDocuments(ImportDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation ImportDocuments(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
ImportDocumentsAsync(ImportDocumentsRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, CallOptions options)Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
ImportDocumentsAsync(ImportDocumentsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.
| Parameters | |
|---|---|
| Name | Description |
request | ImportDocumentsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
ListDatabases(ListDatabasesRequest, CallOptions)
public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, CallOptions options)List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListDatabasesResponse | The response received from the server. |
ListDatabases(ListDatabasesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListDatabasesResponse | The response received from the server. |
ListDatabasesAsync(ListDatabasesRequest, CallOptions)
public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, CallOptions options)List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListDatabasesResponse> | The call object. |
ListDatabasesAsync(ListDatabasesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListDatabasesResponse> | The call object. |
ListFields(ListFieldsRequest, CallOptions)
public virtual ListFieldsResponse ListFields(ListFieldsRequest request, CallOptions options)Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
that have been explicitly overridden. To issue this query, call
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
indexConfig.usesAncestorConfig:false .
| Parameters | |
|---|---|
| Name | Description |
request | ListFieldsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListFieldsResponse | The response received from the server. |
ListFields(ListFieldsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListFieldsResponse ListFields(ListFieldsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
that have been explicitly overridden. To issue this query, call
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
indexConfig.usesAncestorConfig:false .
| Parameters | |
|---|---|
| Name | Description |
request | ListFieldsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListFieldsResponse | The response received from the server. |
ListFieldsAsync(ListFieldsRequest, CallOptions)
public virtual AsyncUnaryCall<ListFieldsResponse> ListFieldsAsync(ListFieldsRequest request, CallOptions options)Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
that have been explicitly overridden. To issue this query, call
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
indexConfig.usesAncestorConfig:false .
| Parameters | |
|---|---|
| Name | Description |
request | ListFieldsRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListFieldsResponse> | The call object. |
ListFieldsAsync(ListFieldsRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListFieldsResponse> ListFieldsAsync(ListFieldsRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Lists the field configuration and metadata for this database.
Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
that have been explicitly overridden. To issue this query, call
[FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
indexConfig.usesAncestorConfig:false .
| Parameters | |
|---|---|
| Name | Description |
request | ListFieldsRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListFieldsResponse> | The call object. |
ListIndexes(ListIndexesRequest, CallOptions)
public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexesResponse | The response received from the server. |
ListIndexes(ListIndexesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
ListIndexesResponse | The response received from the server. |
ListIndexesAsync(ListIndexesRequest, CallOptions)
public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListIndexesResponse> | The call object. |
ListIndexesAsync(ListIndexesRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<ListIndexesResponse> | The call object. |
NewInstance(ClientBase.ClientBaseConfiguration)
protected override FirestoreAdmin.FirestoreAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)Creates a new instance of client from given ClientBaseConfiguration.
| Parameter | |
|---|---|
| Name | Description |
configuration | ClientBase.ClientBaseConfiguration |
| Returns | |
|---|---|
| Type | Description |
FirestoreAdmin.FirestoreAdminClient | |
UpdateDatabase(UpdateDatabaseRequest, CallOptions)
public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, CallOptions options)Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateDatabase(UpdateDatabaseRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateDatabaseAsync(UpdateDatabaseRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, CallOptions options)Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
UpdateDatabaseAsync(UpdateDatabaseRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
UpdateField(UpdateFieldRequest, CallOptions)
public virtual Operation UpdateField(UpdateFieldRequest request, CallOptions options)Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use
the special Field with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFieldRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateField(UpdateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual Operation UpdateField(UpdateFieldRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use
the special Field with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFieldRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
Operation | The response received from the server. |
UpdateFieldAsync(UpdateFieldRequest, CallOptions)
public virtual AsyncUnaryCall<Operation> UpdateFieldAsync(UpdateFieldRequest request, CallOptions options)Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use
the special Field with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFieldRequestThe request to send to the server. |
options | CallOptionsThe options for the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |
UpdateFieldAsync(UpdateFieldRequest, Metadata, Nullable<DateTime>, CancellationToken)
public virtual AsyncUnaryCall<Operation> UpdateFieldAsync(UpdateFieldRequest request, Metadata headers = null, DateTime? deadline = default(DateTime? ), CancellationToken cancellationToken = default(CancellationToken))Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].
To configure the default field settings for the database, use
the special Field with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateFieldRequestThe request to send to the server. |
headers | MetadataThe initial metadata to send with the call. This parameter is optional. |
deadline | Nullable<DateTime>An optional deadline for the call. The call will be cancelled if deadline is hit. |
cancellationToken | CancellationTokenAn optional token for canceling the call. |
| Returns | |
|---|---|
| Type | Description |
AsyncUnaryCall<Operation> | The call object. |