Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Updates or inserts a document.

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

REST Resource

type ProjectsDatabasesDocumentsPatchResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParams "updateMask.fieldPaths" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "currentDocument.exists" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "currentDocument.updateTime" DateTime' :> (QueryParams "mask.fieldPaths" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] Document :> Patch '[JSON] Document))))))))))))

A resource alias for firestore.projects.databases.documents.patch method which the ProjectsDatabasesDocumentsPatch request conforms to.

Creating a Request

projectsDatabasesDocumentsPatch

Arguments

:: Document

pddpPayload

-> Text

pddpName

-> ProjectsDatabasesDocumentsPatch

Creates a value of ProjectsDatabasesDocumentsPatch with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pddpXgafv
• pddpUpdateMaskFieldPaths
• pddpUploadProtocol
• pddpCurrentDocumentExists
• pddpAccessToken
• pddpUploadType
• pddpPayload
• pddpCurrentDocumentUpdateTime
• pddpName
• pddpMaskFieldPaths
• pddpCallback

data ProjectsDatabasesDocumentsPatch

Updates or inserts a document.

See: projectsDatabasesDocumentsPatch smart constructor.

Instances

Eq ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Methods

(==) :: ProjectsDatabasesDocumentsPatch -> ProjectsDatabasesDocumentsPatch -> Bool

(/=) :: ProjectsDatabasesDocumentsPatch -> ProjectsDatabasesDocumentsPatch -> Bool

Data ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Methods

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

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

toConstr :: ProjectsDatabasesDocumentsPatch -> Constr

dataTypeOf :: ProjectsDatabasesDocumentsPatch -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesDocumentsPatch -> ProjectsDatabasesDocumentsPatch

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

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

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

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

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

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

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

Show ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsPatch -> ShowS

show :: ProjectsDatabasesDocumentsPatch -> String

showList :: [ProjectsDatabasesDocumentsPatch] -> ShowS

Generic ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Associated Types

type Rep ProjectsDatabasesDocumentsPatch :: Type -> Type

Methods

from :: ProjectsDatabasesDocumentsPatch -> Rep ProjectsDatabasesDocumentsPatch x

to :: Rep ProjectsDatabasesDocumentsPatch x -> ProjectsDatabasesDocumentsPatch

GoogleRequest ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

Associated Types

type Rs ProjectsDatabasesDocumentsPatch :: Type

type Scopes ProjectsDatabasesDocumentsPatch :: [Symbol]

Methods

requestClient :: ProjectsDatabasesDocumentsPatch -> GClient (Rs ProjectsDatabasesDocumentsPatch)

type Rep ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

type Rep ProjectsDatabasesDocumentsPatch = D1 (MetaData "ProjectsDatabasesDocumentsPatch" "Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsPatch'" PrefixI True) (((S1 (MetaSel (Just "_pddpXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pddpUpdateMaskFieldPaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 (MetaSel (Just "_pddpUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pddpCurrentDocumentExists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_pddpAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 (MetaSel (Just "_pddpUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_pddpPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Document) :*: S1 (MetaSel (Just "_pddpCurrentDocumentUpdateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime')))) :*: (S1 (MetaSel (Just "_pddpName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: (S1 (MetaSel (Just "_pddpMaskFieldPaths") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 (MetaSel (Just "_pddpCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))))

type Scopes ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

type Scopes ProjectsDatabasesDocumentsPatch = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))

type Rs ProjectsDatabasesDocumentsPatch

Defined in Network.Google.Resource.FireStore.Projects.Databases.Documents.Patch

type Rs ProjectsDatabasesDocumentsPatch = Document

Request Lenses

pddpXgafv :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Xgafv)

V1 error format.

pddpUpdateMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsPatch [Text]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

pddpUploadProtocol :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Text)

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

pddpCurrentDocumentExists :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Bool)

When set to `true`, the target document must exist. When set to `false`, the target document must not exist.

pddpAccessToken :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Text)

OAuth access token.

pddpUploadType :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Text)

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

pddpPayload :: Lens' ProjectsDatabasesDocumentsPatch Document

Multipart request metadata.

pddpCurrentDocumentUpdateTime :: Lens' ProjectsDatabasesDocumentsPatch (Maybe UTCTime)

When set, the target document must exist and have been last updated at that time.

pddpName :: Lens' ProjectsDatabasesDocumentsPatch Text

The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

pddpMaskFieldPaths :: Lens' ProjectsDatabasesDocumentsPatch [Text]

The list of field paths in the mask. See Document.fields for a field path syntax reference.

pddpCallback :: Lens' ProjectsDatabasesDocumentsPatch (Maybe Text)

JSONP