Copyright	(c) 2015-2025 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <[email protected]> Toni Cebrián <[email protected]>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	GHC2021

Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Contents

Resource
- Constructing a Request

Description

Leases a dataflow WorkItem to run.

See: Dataflow API Reference for dataflow.projects.jobs.workItems.lease.

Synopsis

type DataflowProjectsJobsWorkItemsLeaseResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (Capture "jobId" Text :> ("workItems:lease" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LeaseWorkItemRequest :> Post '[JSON] LeaseWorkItemResponse))))))))))))
data DataflowProjectsJobsWorkItemsLease = DataflowProjectsJobsWorkItemsLease {
- xgafv :: Maybe Xgafv
- accessToken :: Maybe Text
- callback :: Maybe Text
- jobId :: Text
- payload :: LeaseWorkItemRequest
- projectId :: Text
- uploadType :: Maybe Text
- uploadProtocol :: Maybe Text
}
newDataflowProjectsJobsWorkItemsLease :: Text -> LeaseWorkItemRequest -> Text -> DataflowProjectsJobsWorkItemsLease

Resource

type DataflowProjectsJobsWorkItemsLeaseResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (Capture "jobId" Text :> ("workItems:lease" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "access_token" Text :> (QueryParam "callback" Text :> (QueryParam "uploadType" Text :> (QueryParam "upload_protocol" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LeaseWorkItemRequest :> Post '[JSON] LeaseWorkItemResponse)))))))))))) Source #

A resource alias for dataflow.projects.jobs.workItems.lease method which the DataflowProjectsJobsWorkItemsLease request conforms to.

Constructing a Request

data DataflowProjectsJobsWorkItemsLease Source #

Leases a dataflow WorkItem to run.

See: newDataflowProjectsJobsWorkItemsLease smart constructor.

Constructors

DataflowProjectsJobsWorkItemsLease

Fields

xgafv :: Maybe Xgafv
V1 error format.
accessToken :: Maybe Text
OAuth access token.
callback :: Maybe Text
JSONP
jobId :: Text
Identifies the workflow job this worker belongs to.
payload :: LeaseWorkItemRequest
Multipart request metadata.
projectId :: Text
Identifies the project this worker belongs to.
uploadType :: Maybe Text
Legacy upload protocol for media (e.g. "media", "multipart").
uploadProtocol :: Maybe Text
Upload protocol for media (e.g. "raw", "multipart").

Instances

Instances details

Generic DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Associated Types

type Rep DataflowProjectsJobsWorkItemsLease

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Methods

from :: DataflowProjectsJobsWorkItemsLease -> Rep DataflowProjectsJobsWorkItemsLease x #

to :: Rep DataflowProjectsJobsWorkItemsLease x -> DataflowProjectsJobsWorkItemsLease #

Show DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Methods

showsPrec :: Int -> DataflowProjectsJobsWorkItemsLease -> ShowS #

show :: DataflowProjectsJobsWorkItemsLease -> String #

showList :: [DataflowProjectsJobsWorkItemsLease] -> ShowS #

Eq DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Methods

(==) :: DataflowProjectsJobsWorkItemsLease -> DataflowProjectsJobsWorkItemsLease -> Bool #

(/=) :: DataflowProjectsJobsWorkItemsLease -> DataflowProjectsJobsWorkItemsLease -> Bool #

GoogleRequest DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

Associated Types

type Rs DataflowProjectsJobsWorkItemsLease
Instance details Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease type Rs DataflowProjectsJobsWorkItemsLease = LeaseWorkItemResponse
type Scopes DataflowProjectsJobsWorkItemsLease
Instance details Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease type Scopes DataflowProjectsJobsWorkItemsLease = '[CloudPlatform'FullControl, Compute'FullControl]

Methods

requestClient :: DataflowProjectsJobsWorkItemsLease -> GClient (Rs DataflowProjectsJobsWorkItemsLease) #

type Rep DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

type Rs DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

type Rs DataflowProjectsJobsWorkItemsLease = LeaseWorkItemResponse

type Scopes DataflowProjectsJobsWorkItemsLease Source #

Instance details

Defined in Gogol.Dataflow.Projects.Jobs.WorkItems.Lease

type Scopes DataflowProjectsJobsWorkItemsLease = '[CloudPlatform'FullControl, Compute'FullControl]

newDataflowProjectsJobsWorkItemsLease Source #

Arguments

:: Text	Identifies the workflow job this worker belongs to. See `jobId`.
-> LeaseWorkItemRequest	Multipart request metadata. See `payload`.
-> Text	Identifies the project this worker belongs to. See `projectId`.
-> DataflowProjectsJobsWorkItemsLease

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