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.CloudPrivateCatalogProducer.Catalogs.Delete

Contents

REST Resource
Creating a Request
Request Lenses

Description

Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method.

See: Cloud Private Catalog Producer API Reference for cloudprivatecatalogproducer.catalogs.delete.

Synopsis

type CatalogsDeleteResource = "v1beta1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "force" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] GoogleCloudPrivatecatalogproducerV1beta1Catalog))))))))
catalogsDelete :: Text -> CatalogsDelete
data CatalogsDelete
cdXgafv :: Lens' CatalogsDelete (Maybe Xgafv)
cdUploadProtocol :: Lens' CatalogsDelete (Maybe Text)
cdForce :: Lens' CatalogsDelete (Maybe Bool)
cdAccessToken :: Lens' CatalogsDelete (Maybe Text)
cdUploadType :: Lens' CatalogsDelete (Maybe Text)
cdName :: Lens' CatalogsDelete Text
cdCallback :: Lens' CatalogsDelete (Maybe Text)

REST Resource

type CatalogsDeleteResource = "v1beta1" :> (Capture "name" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "force" Bool :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Delete '[JSON] GoogleCloudPrivatecatalogproducerV1beta1Catalog)))))))) Source #

A resource alias for cloudprivatecatalogproducer.catalogs.delete method which the CatalogsDelete request conforms to.

Creating a Request

catalogsDelete Source #

Arguments

:: Text	`cdName`
-> CatalogsDelete

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

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

data CatalogsDelete Source #

Soft deletes an existing Catalog and all resources under it. The catalog can only be deleted if there is no associations under it or DeleteCatalogRequest.force is true. The delete operation can be recovered by the PrivateCatalogProducer.UndeleteCatalog method.

See: catalogsDelete smart constructor.

Instances

Eq CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete Methods (==) :: CatalogsDelete -> CatalogsDelete -> Bool # (/=) :: CatalogsDelete -> CatalogsDelete -> Bool #
Data CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CatalogsDelete -> c CatalogsDelete # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CatalogsDelete # toConstr :: CatalogsDelete -> Constr # dataTypeOf :: CatalogsDelete -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CatalogsDelete) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CatalogsDelete) # gmapT :: (forall b. Data b => b -> b) -> CatalogsDelete -> CatalogsDelete # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CatalogsDelete -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CatalogsDelete -> r # gmapQ :: (forall d. Data d => d -> u) -> CatalogsDelete -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CatalogsDelete -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CatalogsDelete -> m CatalogsDelete # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CatalogsDelete -> m CatalogsDelete # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CatalogsDelete -> m CatalogsDelete #
Show CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete Methods showsPrec :: Int -> CatalogsDelete -> ShowS # show :: CatalogsDelete -> String # showList :: [CatalogsDelete] -> ShowS #
Generic CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete Associated Types type Rep CatalogsDelete :: Type -> Type # Methods from :: CatalogsDelete -> Rep CatalogsDelete x # to :: Rep CatalogsDelete x -> CatalogsDelete #
GoogleRequest CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete Associated Types type Rs CatalogsDelete :: Type # type Scopes CatalogsDelete :: [Symbol] # Methods requestClient :: CatalogsDelete -> GClient (Rs CatalogsDelete) #
type Rep CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete type Rep CatalogsDelete = D1 (MetaData "CatalogsDelete" "Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete" "gogol-cloudprivatecatalogproducer-0.5.0-Ej5t4cyBTDrEBSn5TJVMso" False) (C1 (MetaCons "CatalogsDelete'" PrefixI True) ((S1 (MetaSel (Just "_cdXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_cdUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cdForce") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) :: ((S1 (MetaSel (Just "_cdAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_cdUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_cdName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_cdCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete type Scopes CatalogsDelete = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs CatalogsDelete Source #
Instance details Defined in Network.Google.Resource.CloudPrivateCatalogProducer.Catalogs.Delete type Rs CatalogsDelete = GoogleCloudPrivatecatalogproducerV1beta1Catalog

Request Lenses

cdXgafv :: Lens' CatalogsDelete (Maybe Xgafv) Source #

V1 error format.

cdUploadProtocol :: Lens' CatalogsDelete (Maybe Text) Source #

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

cdForce :: Lens' CatalogsDelete (Maybe Bool) Source #

Forces deletion of the `Catalog` and its `Association` resources. If the `Catalog` is still associated with other resources and force is not set to true, then the operation fails.

cdAccessToken :: Lens' CatalogsDelete (Maybe Text) Source #

OAuth access token.

cdUploadType :: Lens' CatalogsDelete (Maybe Text) Source #

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

cdName :: Lens' CatalogsDelete Text Source #

The resource name of the catalog.

cdCallback :: Lens' CatalogsDelete (Maybe Text) Source #

JSONP