Cloud Firestore V1 Client - Class GetFieldRequest (1.47.0)

Reference documentation and code samples for the Cloud Firestore V1 Client class GetFieldRequest.

The request for FirestoreAdmin.GetField.

Generated from protobuf message google.firestore.admin.v1.GetFieldRequest

Namespace

Google \ Cloud \ Firestore \ Admin \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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

getName

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

Returns
Type Description
string

setName

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

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameter
Name Description
name string

Required. A name of the form projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id} Please see Google\Cloud\Firestore\Admin\V1\FirestoreAdminClient::fieldName() for help formatting this field.
Returns
Type Description
Google\Cloud\Firestore\Admin\V1\GetFieldRequest