Class FirestoreAdmin.FirestoreAdminClient

public class FirestoreAdminClient : ClientBase<FirestoreAdmin.FirestoreAdminClient>

Client for FirestoreAdmin

Inheritance

Object > ClientBase > ClientBase<FirestoreAdmin.FirestoreAdminClient> > FirestoreAdmin.FirestoreAdminClient

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

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
TypeNameDescription
CallInvokercallInvoker

The 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
TypeNameDescription
Channelchannel

The channel to use to make remote calls.

FirestoreAdminClient(ChannelBase)

public FirestoreAdminClient(ChannelBase channel)

Creates a new client for FirestoreAdmin

Parameter
TypeNameDescription
ChannelBasechannel

The channel to use to make remote calls.

FirestoreAdminClient(ClientBase.ClientBaseConfiguration)

protected FirestoreAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration

The 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
TypeNameDescription
CreateIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
CreateIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
CreateIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
CreateIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeDescription
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
TypeNameDescription
DeleteIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
DeleteIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteIndexAsync(DeleteIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)

Deletes a composite index.

Parameters
TypeNameDescription
DeleteIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
DeleteIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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.

Parameters
TypeNameDescription
ExportDocumentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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.

Parameters
TypeNameDescription
ExportDocumentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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.

Parameters
TypeNameDescription
ExportDocumentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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.

Parameters
TypeNameDescription
ExportDocumentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.

GetField(GetFieldRequest, CallOptions)

public virtual Field GetField(GetFieldRequest request, CallOptions options)

Gets the metadata and configuration for a Field.

Parameters
TypeNameDescription
GetFieldRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
GetFieldRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
GetFieldRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
GetFieldRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Field>

The call object.

GetIndex(GetIndexRequest, CallOptions)

public virtual Index GetIndex(GetIndexRequest request, CallOptions options)

Gets a composite index.

Parameters
TypeNameDescription
GetIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
GetIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Index

The response received from the server.

GetIndexAsync(GetIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)

Gets a composite index.

Parameters
TypeNameDescription
GetIndexRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
GetIndexRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ImportDocumentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ImportDocumentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ImportDocumentsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ImportDocumentsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

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
TypeNameDescription
ListFieldsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ListFieldsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ListFieldsRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ListFieldsRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<ListFieldsResponse>

The call object.

ListIndexes(ListIndexesRequest, CallOptions)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)

Lists composite indexes.

Parameters
TypeNameDescription
ListIndexesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ListIndexesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListIndexesResponse

The response received from the server.

ListIndexesAsync(ListIndexesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)

Lists composite indexes.

Parameters
TypeNameDescription
ListIndexesRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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
TypeNameDescription
ListIndexesRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
TypeNameDescription
ClientBase.ClientBaseConfigurationconfiguration
Returns
TypeDescription
FirestoreAdmin.FirestoreAdminClient
Overrides
Grpc.Core.ClientBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdmin.FirestoreAdminClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

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: &quot;index_config&quot; }.

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
TypeNameDescription
UpdateFieldRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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: &quot;index_config&quot; }.

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
TypeNameDescription
UpdateFieldRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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: &quot;index_config&quot; }.

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
TypeNameDescription
UpdateFieldRequestrequest

The request to send to the server.

CallOptionsoptions

The options for the call.

Returns
TypeDescription
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: &quot;index_config&quot; }.

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
TypeNameDescription
UpdateFieldRequestrequest

The request to send to the server.

Metadataheaders

The initial metadata to send with the call. This parameter is optional.

Nullable<DateTime>deadline

An optional deadline for the call. The call will be cancelled if deadline is hit.

CancellationTokencancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCall<Operation>

The call object.