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

Deletes a document.

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

REST Resource

type ProjectsDatabasesDocumentsDeleteResource = "v1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "currentDocument.exists" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "currentDocument.updateTime" DateTime' :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] Empty)))))))))

A resource alias for firestore.projects.databases.documents.delete method which the ProjectsDatabasesDocumentsDelete request conforms to.

Creating a Request

projectsDatabasesDocumentsDelete

Arguments

:: Text

pdddName

-> ProjectsDatabasesDocumentsDelete

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

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

• pdddXgafv
• pdddUploadProtocol
• pdddCurrentDocumentExists
• pdddAccessToken
• pdddUploadType
• pdddCurrentDocumentUpdateTime
• pdddName
• pdddCallback

data ProjectsDatabasesDocumentsDelete

Deletes a document.

See: projectsDatabasesDocumentsDelete smart constructor.

Instances

Eq ProjectsDatabasesDocumentsDelete

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

Methods

(==) :: ProjectsDatabasesDocumentsDelete -> ProjectsDatabasesDocumentsDelete -> Bool

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

Data ProjectsDatabasesDocumentsDelete

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

Methods

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

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

toConstr :: ProjectsDatabasesDocumentsDelete -> Constr

dataTypeOf :: ProjectsDatabasesDocumentsDelete -> DataType

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

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

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

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

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

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

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

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

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

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

Show ProjectsDatabasesDocumentsDelete

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

Methods

showsPrec :: Int -> ProjectsDatabasesDocumentsDelete -> ShowS

show :: ProjectsDatabasesDocumentsDelete -> String

showList :: [ProjectsDatabasesDocumentsDelete] -> ShowS

Generic ProjectsDatabasesDocumentsDelete

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

Associated Types

type Rep ProjectsDatabasesDocumentsDelete :: Type -> Type

Methods

from :: ProjectsDatabasesDocumentsDelete -> Rep ProjectsDatabasesDocumentsDelete x

to :: Rep ProjectsDatabasesDocumentsDelete x -> ProjectsDatabasesDocumentsDelete

GoogleRequest ProjectsDatabasesDocumentsDelete

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

Associated Types

type Rs ProjectsDatabasesDocumentsDelete :: Type

type Scopes ProjectsDatabasesDocumentsDelete :: [Symbol]

Methods

requestClient :: ProjectsDatabasesDocumentsDelete -> GClient (Rs ProjectsDatabasesDocumentsDelete)

type Rep ProjectsDatabasesDocumentsDelete

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

type Rep ProjectsDatabasesDocumentsDelete = D1 (MetaData "ProjectsDatabasesDocumentsDelete" "Network.Google.Resource.FireStore.Projects.Databases.Documents.Delete" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesDocumentsDelete'" PrefixI True) (((S1 (MetaSel (Just "_pdddXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: S1 (MetaSel (Just "_pdddUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_pdddCurrentDocumentExists") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 (MetaSel (Just "_pdddAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pdddUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pdddCurrentDocumentUpdateTime") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe DateTime'))) :*: (S1 (MetaSel (Just "_pdddName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pdddCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsDatabasesDocumentsDelete

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

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

type Rs ProjectsDatabasesDocumentsDelete

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

type Rs ProjectsDatabasesDocumentsDelete = Empty

Request Lenses

pdddXgafv :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Xgafv)

V1 error format.

pdddUploadProtocol :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Text)

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

pdddCurrentDocumentExists :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Bool)

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

pdddAccessToken :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Text)

OAuth access token.

pdddUploadType :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Text)

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

pdddCurrentDocumentUpdateTime :: Lens' ProjectsDatabasesDocumentsDelete (Maybe UTCTime)

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

pdddName :: Lens' ProjectsDatabasesDocumentsDelete Text

The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

pdddCallback :: Lens' ProjectsDatabasesDocumentsDelete (Maybe Text)

JSONP