Documentation

Google_Service_Firestore_Resource_ProjectsDatabasesCollectionGroupsFields extends Google_Service_Resource
in package

The "fields" collection of methods.

Typical usage is: $firestoreService = new Google_Service_Firestore(...); $fields = $firestoreService->fields;

Table of Contents

$client  : Google_Client
$methods  : array<string|int, mixed>
$resourceName  : string
$rootUrl  : string
$serviceName  : string
$servicePath  : string
$stackParameters  : mixed
__construct()  : mixed
call()  : Google_Http_Request|expectedClass
TODO: This function needs simplifying.
createRequestUri()  : string
Parse/expand request parameters and create a fully qualified request uri.
get()  : Google_Service_Firestore_GoogleFirestoreAdminV1Field
Gets the metadata and configuration for a Field. (fields.get)
listProjectsDatabasesCollectionGroupsFields()  : Google_Service_Firestore_GoogleFirestoreAdminV1ListFieldsResponse
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`.
patch()  : Google_Service_Firestore_GoogleLongrunningOperation
Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to 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 which may be used to track the status of the field update. The metadata for the operation will be the type 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__/f ields`. (fields.patch)
convertToArrayAndStripNulls()  : mixed

Properties

$methods

private array<string|int, mixed> $methods

$resourceName

private string $resourceName

$serviceName

private string $serviceName

$servicePath

private string $servicePath

$stackParameters

private mixed $stackParameters = array('alt' => array('type' => 'string', 'location' => 'query'), 'fields' => array('type' => 'string', 'location' => 'query'), 'trace' => array('type' => 'string', 'location' => 'query'), 'userIp' => array('type' => 'string', 'location' => 'query'), 'quotaUser' => array('type' => 'string', 'location' => 'query'), 'data' => array('type' => 'string', 'location' => 'body'), 'mimeType' => array('type' => 'string', 'location' => 'header'), 'uploadType' => array('type' => 'string', 'location' => 'query'), 'mediaUpload' => array('type' => 'complex', 'location' => 'query'), 'prettyPrint' => array('type' => 'string', 'location' => 'query'))

Methods

__construct()

public __construct(mixed $service, mixed $serviceName, mixed $resourceName, mixed $resource) : mixed
Parameters
$service : mixed
$serviceName : mixed
$resourceName : mixed
$resource : mixed
Return values
mixed —

call()

TODO: This function needs simplifying.

public call( $name,  $arguments[,  $expectedClass = null ]) : Google_Http_Request|expectedClass
Parameters
$name :
$arguments :
$expectedClass : = null
  • optional, the expected class name
Tags
throws
Google_Exception
Return values
Google_Http_Request|expectedClass —

createRequestUri()

Parse/expand request parameters and create a fully qualified request uri.

public createRequestUri(string $restPath, array<string|int, mixed> $params) : string
Parameters
$restPath : string
$params : array<string|int, mixed>
Tags
static
Return values
string —

$requestUrl

get()

Gets the metadata and configuration for a Field. (fields.get)

public get(string $name[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleFirestoreAdminV1Field
Parameters
$name : string

Required. A name of the form projects/{project_id}/datab ases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}

$optParams : array<string|int, mixed> = array()

Optional parameters.

Return values
Google_Service_Firestore_GoogleFirestoreAdminV1Field —

listProjectsDatabasesCollectionGroupsFields()

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`.

public listProjectsDatabasesCollectionGroupsFields(string $parent[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleFirestoreAdminV1ListFieldsResponse

(fields.listProjectsDatabasesCollectionGroupsFields)

Parameters
$parent : string

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

$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

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

opt_param

int pageSize The number of results to return.

opt_param

string 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 the filter set to indexConfig.usesAncestorConfig:false.

Return values
Google_Service_Firestore_GoogleFirestoreAdminV1ListFieldsResponse —

patch()

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to 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 which may be used to track the status of the field update. The metadata for the operation will be the type 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__/f ields`. (fields.patch)

public patch(string $name, Google_Service_Firestore_GoogleFirestoreAdminV1Field $postBody[, array<string|int, mixed> $optParams = array() ]) : Google_Service_Firestore_GoogleLongrunningOperation
Parameters
$name : string

A field name of the form projects/{project_id}/databases /{database_id}/collectionGroups/{collection_id}/fields/{field_path} A field path may be a simple field name, e.g. address or a path to fields within map_value , e.g. address.city, or a special field path. The only valid special field is *, which represents any field. Field paths may be quoted using (backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:, ., ``` (backtick), [, ], as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block) `address.city`represents a field namedaddress.city, not the map key cityin the fieldaddress. ``represents a field named*, not any field. A special Fieldcontains the default indexing settings for all fields. This field's resource name is:projects/{project_id}/databases/{database_id}/collectionGr oups/default/fieldsIndexes defined on thisFieldwill be applied to all fields which do not have their ownField` index configuration.

$postBody : Google_Service_Firestore_GoogleFirestoreAdminV1Field
$optParams : array<string|int, mixed> = array()

Optional parameters.

Tags
opt_param

string updateMask A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.

Return values
Google_Service_Firestore_GoogleLongrunningOperation —

convertToArrayAndStripNulls()

protected convertToArrayAndStripNulls(mixed $o) : mixed
Parameters
$o : mixed
Return values
mixed —

Search results