Show / Hide Table of Contents

Class ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest

Lists the field configuration and metadata for this database. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set to indexConfig.usesAncestorConfig:false or ttlConfig:*.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>
ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest
Implements
IClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>
IClientServiceRequest
Inherited Members
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Xgafv
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.AccessToken
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Alt
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Callback
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Fields
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Key
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.OauthToken
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.PrettyPrint
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.QuotaUser
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.UploadType
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.UploadProtocol
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Execute()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ExecuteAsStream()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ExecuteAsync()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ExecuteAsync(CancellationToken)
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ExecuteAsStreamAsync()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.CreateRequest(bool?)
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.GenerateRequestUri()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.GetBody()
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.GetDefaultETagAction(string)
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ETagAction
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ModifyRequest
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ValidateParameters
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.ApiVersion
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.RequestParameters
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Firestore.v1
Assembly: Google.Apis.Firestore.v1.dll
Syntax
public class ProjectsResource.DatabasesResource.CollectionGroupsResource.FieldsResource.ListRequest : FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>, IClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>, IClientServiceRequest

Constructors

ListRequest(IClientService, string)

Constructs a new List request.

Declaration
public ListRequest(IClientService service, string parent)
Parameters
Type Name Description
IClientService service
string parent

Properties

Filter

The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with a filter that includes indexConfig.usesAncestorConfig:false or ttlConfig:*.

Declaration
[RequestParameter("filter", RequestParameterType.Query)]
public virtual string Filter { get; set; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.HttpMethod

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.MethodName

PageSize

The number of results to return.

Declaration
[RequestParameter("pageSize", RequestParameterType.Query)]
public virtual int? PageSize { get; set; }
Property Value
Type Description
int?

PageToken

A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.

Declaration
[RequestParameter("pageToken", RequestParameterType.Query)]
public virtual string PageToken { get; set; }
Property Value
Type Description
string

Parent

Required. A parent name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}

Declaration
[RequestParameter("parent", RequestParameterType.Path)]
public virtual string Parent { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.RestPath

Methods

InitParameters()

Initializes List parameter list.

Declaration
protected override void InitParameters()
Overrides
FirestoreBaseServiceRequest<GoogleFirestoreAdminV1ListFieldsResponse>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX