public sealed class ListFieldsRequest : IMessage<ListFieldsRequest>, IEquatable<ListFieldsRequest>, IDeepCloneable<ListFieldsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Firestore Admin v1 API class ListFieldsRequest.
The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].
Implements
IMessageListFieldsRequest, IEquatableListFieldsRequest, IDeepCloneableListFieldsRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Constructors
ListFieldsRequest()
public ListFieldsRequest()
ListFieldsRequest(ListFieldsRequest)
public ListFieldsRequest(ListFieldsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListFieldsRequest |
Properties
Filter
public string Filter { get; set; }
The filter to apply to list results. 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 a filter that includes indexConfig.usesAncestorConfig:false
.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
The number of results to return.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
A page token, returned from a previous call to [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields], that may be used to get the next page of results.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. A parent name of the form
projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}
Property Value | |
---|---|
Type | Description |
string |
ParentAsCollectionGroupName
public CollectionGroupName ParentAsCollectionGroupName { get; set; }
CollectionGroupName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
CollectionGroupName |