Copyright	(c) 2015-2016 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create

Contents

REST Resource
Creating a Request
Request Lenses

Description

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

See: Cloud Firestore API Reference for firestore.projects.databases.collectionGroups.indexes.create.

Synopsis

type ProjectsDatabasesCollectionGroupsIndexesCreateResource = "v1" :> (Capture "parent" Text :> ("indexes" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1Index :> Post '[JSON] GoogleLongrunningOperation)))))))))
projectsDatabasesCollectionGroupsIndexesCreate :: Text -> GoogleFirestoreAdminV1Index -> ProjectsDatabasesCollectionGroupsIndexesCreate
data ProjectsDatabasesCollectionGroupsIndexesCreate
pdcgicParent :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate Text
pdcgicXgafv :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Xgafv)
pdcgicUploadProtocol :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text)
pdcgicAccessToken :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text)
pdcgicUploadType :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text)
pdcgicPayload :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate GoogleFirestoreAdminV1Index
pdcgicCallback :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text)

REST Resource

type ProjectsDatabasesCollectionGroupsIndexesCreateResource = "v1" :> (Capture "parent" Text :> ("indexes" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleFirestoreAdminV1Index :> Post '[JSON] GoogleLongrunningOperation))))))))) Source #

A resource alias for firestore.projects.databases.collectionGroups.indexes.create method which the ProjectsDatabasesCollectionGroupsIndexesCreate request conforms to.

Creating a Request

projectsDatabasesCollectionGroupsIndexesCreate Source #

Arguments

:: Text	`pdcgicParent`
-> GoogleFirestoreAdminV1Index	`pdcgicPayload`
-> ProjectsDatabasesCollectionGroupsIndexesCreate

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

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

data ProjectsDatabasesCollectionGroupsIndexesCreate Source #

Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.

See: projectsDatabasesCollectionGroupsIndexesCreate smart constructor.

Instances

Eq ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create Methods (==) :: ProjectsDatabasesCollectionGroupsIndexesCreate -> ProjectsDatabasesCollectionGroupsIndexesCreate -> Bool # (/=) :: ProjectsDatabasesCollectionGroupsIndexesCreate -> ProjectsDatabasesCollectionGroupsIndexesCreate -> Bool #
Data ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> c ProjectsDatabasesCollectionGroupsIndexesCreate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsDatabasesCollectionGroupsIndexesCreate # toConstr :: ProjectsDatabasesCollectionGroupsIndexesCreate -> Constr # dataTypeOf :: ProjectsDatabasesCollectionGroupsIndexesCreate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsDatabasesCollectionGroupsIndexesCreate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsDatabasesCollectionGroupsIndexesCreate) # gmapT :: (forall b. Data b => b -> b) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> ProjectsDatabasesCollectionGroupsIndexesCreate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsIndexesCreate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsDatabasesCollectionGroupsIndexesCreate -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> m ProjectsDatabasesCollectionGroupsIndexesCreate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> m ProjectsDatabasesCollectionGroupsIndexesCreate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsDatabasesCollectionGroupsIndexesCreate -> m ProjectsDatabasesCollectionGroupsIndexesCreate #
Show ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create Methods showsPrec :: Int -> ProjectsDatabasesCollectionGroupsIndexesCreate -> ShowS # show :: ProjectsDatabasesCollectionGroupsIndexesCreate -> String # showList :: [ProjectsDatabasesCollectionGroupsIndexesCreate] -> ShowS #
Generic ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create Associated Types type Rep ProjectsDatabasesCollectionGroupsIndexesCreate :: Type -> Type # Methods from :: ProjectsDatabasesCollectionGroupsIndexesCreate -> Rep ProjectsDatabasesCollectionGroupsIndexesCreate x # to :: Rep ProjectsDatabasesCollectionGroupsIndexesCreate x -> ProjectsDatabasesCollectionGroupsIndexesCreate #
GoogleRequest ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create Associated Types type Rs ProjectsDatabasesCollectionGroupsIndexesCreate :: Type # type Scopes ProjectsDatabasesCollectionGroupsIndexesCreate :: [Symbol] # Methods requestClient :: ProjectsDatabasesCollectionGroupsIndexesCreate -> GClient (Rs ProjectsDatabasesCollectionGroupsIndexesCreate) #
type Rep ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create type Rep ProjectsDatabasesCollectionGroupsIndexesCreate = D1 (MetaData "ProjectsDatabasesCollectionGroupsIndexesCreate" "Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create" "gogol-firestore-0.4.0-GW3AvKXkpND5rISC8pKhKY" False) (C1 (MetaCons "ProjectsDatabasesCollectionGroupsIndexesCreate'" PrefixI True) ((S1 (MetaSel (Just "_pdcgicParent") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: (S1 (MetaSel (Just "_pdcgicXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pdcgicUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pdcgicAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pdcgicUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_pdcgicPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleFirestoreAdminV1Index) :: S1 (MetaSel (Just "_pdcgicCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create type Scopes ProjectsDatabasesCollectionGroupsIndexesCreate = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/datastore" ': ([] :: [Symbol]))
type Rs ProjectsDatabasesCollectionGroupsIndexesCreate Source #
Instance details Defined in Network.Google.Resource.FireStore.Projects.Databases.CollectionGroups.Indexes.Create type Rs ProjectsDatabasesCollectionGroupsIndexesCreate = GoogleLongrunningOperation

Request Lenses

pdcgicParent :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate Text Source #

A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`

pdcgicXgafv :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Xgafv) Source #

V1 error format.

pdcgicUploadProtocol :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text) Source #

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

pdcgicAccessToken :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text) Source #

OAuth access token.

pdcgicUploadType :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text) Source #

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

pdcgicPayload :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate GoogleFirestoreAdminV1Index Source #

Multipart request metadata.

pdcgicCallback :: Lens' ProjectsDatabasesCollectionGroupsIndexesCreate (Maybe Text) Source #

JSONP