gogol-firestore-0.4.0: Google Cloud Firestore SDK.

Copyright(c) 2015-2016 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

Contents

Description

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/fields/*`.

See: Cloud Firestore API Reference for firestore.projects.databases.collectionGroups.fields.patch.

Synopsis

REST Resource

type ProjectsDatabasesCollectionGroupsFieldsPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "updateMask" GFieldMask :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1Field :> Patch '[JSON] GoogleLongrunningOperation))))))))) Source #

A resource alias for firestore.projects.databases.collectionGroups.fields.patch method which the ProjectsDatabasesCollectionGroupsFieldsPatch request conforms to.

Creating a Request

data ProjectsDatabasesCollectionGroupsFieldsPatch Source #

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/fields/*`.

See: projectsDatabasesCollectionGroupsFieldsPatch smart constructor.

Instances
Eq ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

Data ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> c ProjectsDatabasesCollectionGroupsFieldsPatch #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesCollectionGroupsFieldsPatch #

toConstr :: ProjectsDatabasesCollectionGroupsFieldsPatch -> Constr #

dataTypeOf :: ProjectsDatabasesCollectionGroupsFieldsPatch -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesCollectionGroupsFieldsPatch) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesCollectionGroupsFieldsPatch) #

gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> ProjectsDatabasesCollectionGroupsFieldsPatch #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsFieldsPatch -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsFieldsPatch -> r #

gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> m ProjectsDatabasesCollectionGroupsFieldsPatch #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> m ProjectsDatabasesCollectionGroupsFieldsPatch #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsFieldsPatch -> m ProjectsDatabasesCollectionGroupsFieldsPatch #

Show ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

Generic ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

GoogleRequest ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

type Rep ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

type Rep ProjectsDatabasesCollectionGroupsFieldsPatch = D1 (MetaData "ProjectsDatabasesCollectionGroupsFieldsPatch" "Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesCollectionGroupsFieldsPatch'" PrefixI True) (((S1 (MetaSel (Just "_pdcgfpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pdcgfpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pdcgfpUpdateMask") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe GFieldMask)) :*: S1 (MetaSel (Just "_pdcgfpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pdcgfpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pdcgfpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleFirestoreAdminV1Field)) :*: (S1 (MetaSel (Just "_pdcgfpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pdcgfpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

type Scopes ProjectsDatabasesCollectionGroupsFieldsPatch = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesCollectionGroupsFieldsPatch Source # 
Instance details

Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Fields.Patch

Request Lenses

pdcgfpUploadProtocol :: Lens' ProjectsDatabasesCollectionGroupsFieldsPatch (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

pdcgfpUpdateMask :: Lens' ProjectsDatabasesCollectionGroupsFieldsPatch (Maybe GFieldMask) Source #

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

pdcgfpUploadType :: Lens' ProjectsDatabasesCollectionGroupsFieldsPatch (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

pdcgfpName :: Lens' ProjectsDatabasesCollectionGroupsFieldsPatch Text Source #

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 named `address.city`, not the map key `city` in the field `address`. `\`*\`` represents a field named `*`, not any field. A special `Field` contains the default indexing settings for all fields. This field's resource name is: `projects/{project_id}/databases/{database_id}/collectionGroups/default/fields/*` Indexes defined on this `Field` will be applied to all fields which do not have their own `Field` index configuration.