Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

See: Cloud Tasks API Reference for cloudtasks.projects.locations.queues.purge.

REST Resource

type ProjectsLocationsQueuesPurgeResource = "v2beta3" :> (CaptureMode "name" "purge" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] PurgeQueueRequest :> Post '[JSON] Queue))))))))

A resource alias for cloudtasks.projects.locations.queues.purge method which the ProjectsLocationsQueuesPurge request conforms to.

Creating a Request

projectsLocationsQueuesPurge

Arguments

:: PurgeQueueRequest

pPayload

-> Text

pName

-> ProjectsLocationsQueuesPurge

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

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

• pXgafv
• pUploadProtocol
• pAccessToken
• pUploadType
• pPayload
• pName
• pCallback

data ProjectsLocationsQueuesPurge

Purges a queue by deleting all of its tasks. All tasks created before this method is called are permanently deleted. Purge operations can take up to one minute to take effect. Tasks might be dispatched before the purge takes effect. A purge is irreversible.

See: projectsLocationsQueuesPurge smart constructor.

Instances

Eq ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Methods

(==) :: ProjectsLocationsQueuesPurge -> ProjectsLocationsQueuesPurge -> Bool

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

Data ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Methods

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

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

toConstr :: ProjectsLocationsQueuesPurge -> Constr

dataTypeOf :: ProjectsLocationsQueuesPurge -> DataType

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

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

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

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

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

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

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

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

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

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

Show ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Methods

showsPrec :: Int -> ProjectsLocationsQueuesPurge -> ShowS

show :: ProjectsLocationsQueuesPurge -> String

showList :: [ProjectsLocationsQueuesPurge] -> ShowS

Generic ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Associated Types

type Rep ProjectsLocationsQueuesPurge :: Type -> Type

Methods

from :: ProjectsLocationsQueuesPurge -> Rep ProjectsLocationsQueuesPurge x

to :: Rep ProjectsLocationsQueuesPurge x -> ProjectsLocationsQueuesPurge

GoogleRequest ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

Associated Types

type Rs ProjectsLocationsQueuesPurge :: Type

type Scopes ProjectsLocationsQueuesPurge :: [Symbol]

Methods

requestClient :: ProjectsLocationsQueuesPurge -> GClient (Rs ProjectsLocationsQueuesPurge)

type Rep ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

type Rep ProjectsLocationsQueuesPurge = D1 (MetaData "ProjectsLocationsQueuesPurge" "Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge" "gogol-cloudtasks-0.4.0-JYw8G9RDcROAs8IJ376NEk" False) (C1 (MetaCons "ProjectsLocationsQueuesPurge'" PrefixI True) ((S1 (MetaSel (Just "_pXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :*: (S1 (MetaSel (Just "_pUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 (MetaSel (Just "_pUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_pPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 PurgeQueueRequest)) :*: (S1 (MetaSel (Just "_pName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))

type Scopes ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

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

type Rs ProjectsLocationsQueuesPurge

Defined in Network.Google.Resource.CloudTasks.Projects.Locations.Queues.Purge

type Rs ProjectsLocationsQueuesPurge = Queue

Request Lenses

pXgafv :: Lens' ProjectsLocationsQueuesPurge (Maybe Xgafv)

V1 error format.

pUploadProtocol :: Lens' ProjectsLocationsQueuesPurge (Maybe Text)

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

pAccessToken :: Lens' ProjectsLocationsQueuesPurge (Maybe Text)

OAuth access token.

pUploadType :: Lens' ProjectsLocationsQueuesPurge (Maybe Text)

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

pPayload :: Lens' ProjectsLocationsQueuesPurge PurgeQueueRequest

Multipart request metadata.

pName :: Lens' ProjectsLocationsQueuesPurge Text

Required. The queue name. For example: `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`

pCallback :: Lens' ProjectsLocationsQueuesPurge (Maybe Text)

JSONP