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 |
- Service Configuration
- OAuth Scopes
- API Declaration
- Resources
- Types
- JobExecutionInfoStages
- ComputationTopology
- SourceSplitResponse
- Status
- WorkItem
- WorkerHealthReport
- SourceSplitOptions
- WorkerPoolMetadata
- AutoscalingSettings
- JobExecutionStageInfo
- InstructionOutput
- ReportWorkItemStatusRequest
- EnvironmentVersion
- Sink
- WorkerHealthReportResponse
- MetricStructuredName
- WriteInstruction
- EnvironmentUserAgent
- Disk
- MetricUpdate
- SourceGetMetadataResponse
- Environment
- ConcatPosition
- MetricStructuredNameContext
- StreamingStageLocation
- DerivedSource
- JobMetrics
- WorkItemStatus
- WorkerMessageLabels
- FlattenInstruction
- WorkerMessageCode
- JobTransformNameMApping
- SourceSpec
- SourceMetadata
- EnvironmentInternalExperiments
- TaskRunnerSettings
- EnvironmentSdkPipelineOptions
- LeaseWorkItemRequest
- SourceOperationResponse
- TopologyConfigUserStageToComputationNameMap
- ShellTask
- StatusDetailsItem
- ReportedParallelism
- StepProperties
- TopologyConfig
- ApproximateSplitRequest
- WorkerSettings
- WorkItemServiceStateHarnessData
- DataDiskAssignment
- WorkerMessageResponse
- WorkItemServiceState
- StreamingSetupTask
- PartialGroupByKeyInstructionInputElementCodec
- MapTask
- MountedDataDisk
- SinkCodec
- WorkerHealthReportPodsItem
- ParDoInstructionUserFn
- InstructionOutputCodec
- StreamLocation
- WorkerPoolPoolArgs
- SendWorkerMessagesResponse
- StreamingSideInputLocation
- StreamingComputationTask
- JobMessage
- SeqMapTaskOutputInfo
- SourceGetMetadataRequest
- SeqMapTaskUserFn
- PartialGroupByKeyInstructionValueCombiningFn
- Job
- ReadInstruction
- ApproximateReportedProgress
- SinkSpec
- WorkerPool
- Step
- Package
- WorkerMessageCodeParameters
- DynamicSourceSplit
- ReportWorkItemStatusResponse
- SourceFork
- StreamingComputationRanges
- ListJobsResponse
- Source
- ApproximateProgress
- WorkerMessage
- KeyRangeLocation
- MultiOutputInfo
- PartialGroupByKeyInstruction
- ParDoInstruction
- CustomSourceLocation
- SourceBaseSpecsItem
- ParallelInstruction
- SideInputInfoKind
- SendWorkerMessagesRequest
- SourceSplitShard
- SideInputInfo
- JobExecutionInfo
- SourceCodec
- StateFamilyConfig
- KeyRangeDataDiskAssignment
- SourceSplitRequest
- ListJobMessagesResponse
- PubsubLocation
- InstructionInput
- SeqMapTask
- SourceOperationRequest
- LeaseWorkItemResponse
- Position
Develops and executes data processing patterns like ETL, batch computation, and continuous computation.
- dataflowService :: ServiceConfig
- userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- type DataflowAPI = ProjectsJobsWorkItemsLeaseResource :<|> (ProjectsJobsWorkItemsReportStatusResource :<|> (ProjectsJobsMessagesListResource :<|> (ProjectsJobsListResource :<|> (ProjectsJobsGetResource :<|> (ProjectsJobsCreateResource :<|> (ProjectsJobsUpdateResource :<|> (ProjectsJobsGetMetricsResource :<|> ProjectsWorkerMessagesResource)))))))
- module Network.Google.Resource.Dataflow.Projects.Jobs.Create
- module Network.Google.Resource.Dataflow.Projects.Jobs.Get
- module Network.Google.Resource.Dataflow.Projects.Jobs.GetMetrics
- module Network.Google.Resource.Dataflow.Projects.Jobs.List
- module Network.Google.Resource.Dataflow.Projects.Jobs.Messages.List
- module Network.Google.Resource.Dataflow.Projects.Jobs.Update
- module Network.Google.Resource.Dataflow.Projects.Jobs.WorkItems.Lease
- module Network.Google.Resource.Dataflow.Projects.Jobs.WorkItems.ReportStatus
- module Network.Google.Resource.Dataflow.Projects.WorkerMessages
- data JobExecutionInfoStages
- jobExecutionInfoStages :: HashMap Text JobExecutionStageInfo -> JobExecutionInfoStages
- jeisAddtional :: Lens' JobExecutionInfoStages (HashMap Text JobExecutionStageInfo)
- data ComputationTopology
- computationTopology :: ComputationTopology
- ctStateFamilies :: Lens' ComputationTopology [StateFamilyConfig]
- ctUserStageName :: Lens' ComputationTopology (Maybe Text)
- ctInputs :: Lens' ComputationTopology [StreamLocation]
- ctKeyRanges :: Lens' ComputationTopology [KeyRangeLocation]
- ctOutputs :: Lens' ComputationTopology [StreamLocation]
- ctComputationId :: Lens' ComputationTopology (Maybe Text)
- ctSystemStageName :: Lens' ComputationTopology (Maybe Text)
- data SourceSplitResponse
- sourceSplitResponse :: SourceSplitResponse
- ssrBundles :: Lens' SourceSplitResponse [DerivedSource]
- ssrShards :: Lens' SourceSplitResponse [SourceSplitShard]
- ssrOutcome :: Lens' SourceSplitResponse (Maybe Text)
- data Status
- status :: Status
- sDetails :: Lens' Status [StatusDetailsItem]
- sCode :: Lens' Status (Maybe Int32)
- sMessage :: Lens' Status (Maybe Text)
- data WorkItem
- workItem :: WorkItem
- wiJobId :: Lens' WorkItem (Maybe Text)
- wiReportStatusInterval :: Lens' WorkItem (Maybe Text)
- wiShellTask :: Lens' WorkItem (Maybe ShellTask)
- wiStreamingSetupTask :: Lens' WorkItem (Maybe StreamingSetupTask)
- wiInitialReportIndex :: Lens' WorkItem (Maybe Int64)
- wiMapTask :: Lens' WorkItem (Maybe MapTask)
- wiPackages :: Lens' WorkItem [Package]
- wiStreamingComputationTask :: Lens' WorkItem (Maybe StreamingComputationTask)
- wiSourceOperationTask :: Lens' WorkItem (Maybe SourceOperationRequest)
- wiId :: Lens' WorkItem (Maybe Int64)
- wiProjectId :: Lens' WorkItem (Maybe Text)
- wiLeaseExpireTime :: Lens' WorkItem (Maybe Text)
- wiConfiguration :: Lens' WorkItem (Maybe Text)
- wiSeqMapTask :: Lens' WorkItem (Maybe SeqMapTask)
- data WorkerHealthReport
- workerHealthReport :: WorkerHealthReport
- whrVMIsHealthy :: Lens' WorkerHealthReport (Maybe Bool)
- whrReportInterval :: Lens' WorkerHealthReport (Maybe Text)
- whrPods :: Lens' WorkerHealthReport [WorkerHealthReportPodsItem]
- whrVMStartupTime :: Lens' WorkerHealthReport (Maybe Text)
- data SourceSplitOptions
- sourceSplitOptions :: SourceSplitOptions
- ssoDesiredShardSizeBytes :: Lens' SourceSplitOptions (Maybe Int64)
- ssoDesiredBundleSizeBytes :: Lens' SourceSplitOptions (Maybe Int64)
- data WorkerPoolMetadata
- workerPoolMetadata :: HashMap Text Text -> WorkerPoolMetadata
- wpmAddtional :: Lens' WorkerPoolMetadata (HashMap Text Text)
- data AutoscalingSettings
- autoscalingSettings :: AutoscalingSettings
- asMaxNumWorkers :: Lens' AutoscalingSettings (Maybe Int32)
- asAlgorithm :: Lens' AutoscalingSettings (Maybe Text)
- data JobExecutionStageInfo
- jobExecutionStageInfo :: JobExecutionStageInfo
- jesiStepName :: Lens' JobExecutionStageInfo [Text]
- data InstructionOutput
- instructionOutput :: InstructionOutput
- ioCodec :: Lens' InstructionOutput (Maybe InstructionOutputCodec)
- ioName :: Lens' InstructionOutput (Maybe Text)
- ioSystemName :: Lens' InstructionOutput (Maybe Text)
- data ReportWorkItemStatusRequest
- reportWorkItemStatusRequest :: ReportWorkItemStatusRequest
- rwisrCurrentWorkerTime :: Lens' ReportWorkItemStatusRequest (Maybe Text)
- rwisrWorkItemStatuses :: Lens' ReportWorkItemStatusRequest [WorkItemStatus]
- rwisrWorkerId :: Lens' ReportWorkItemStatusRequest (Maybe Text)
- data EnvironmentVersion
- environmentVersion :: HashMap Text JSONValue -> EnvironmentVersion
- evAddtional :: Lens' EnvironmentVersion (HashMap Text JSONValue)
- data Sink
- sink :: Sink
- sCodec :: Lens' Sink (Maybe SinkCodec)
- sSpec :: Lens' Sink (Maybe SinkSpec)
- data WorkerHealthReportResponse
- workerHealthReportResponse :: WorkerHealthReportResponse
- whrrReportInterval :: Lens' WorkerHealthReportResponse (Maybe Text)
- data MetricStructuredName
- metricStructuredName :: MetricStructuredName
- msnOrigin :: Lens' MetricStructuredName (Maybe Text)
- msnContext :: Lens' MetricStructuredName (Maybe MetricStructuredNameContext)
- msnName :: Lens' MetricStructuredName (Maybe Text)
- data WriteInstruction
- writeInstruction :: WriteInstruction
- wiSink :: Lens' WriteInstruction (Maybe Sink)
- wiInput :: Lens' WriteInstruction (Maybe InstructionInput)
- data EnvironmentUserAgent
- environmentUserAgent :: HashMap Text JSONValue -> EnvironmentUserAgent
- euaAddtional :: Lens' EnvironmentUserAgent (HashMap Text JSONValue)
- data Disk
- disk :: Disk
- dSizeGb :: Lens' Disk (Maybe Int32)
- dDiskType :: Lens' Disk (Maybe Text)
- dMountPoint :: Lens' Disk (Maybe Text)
- data MetricUpdate
- metricUpdate :: MetricUpdate
- muMeanSum :: Lens' MetricUpdate (Maybe JSONValue)
- muInternal :: Lens' MetricUpdate (Maybe JSONValue)
- muSet :: Lens' MetricUpdate (Maybe JSONValue)
- muCumulative :: Lens' MetricUpdate (Maybe Bool)
- muKind :: Lens' MetricUpdate (Maybe Text)
- muUpdateTime :: Lens' MetricUpdate (Maybe Text)
- muMeanCount :: Lens' MetricUpdate (Maybe JSONValue)
- muName :: Lens' MetricUpdate (Maybe MetricStructuredName)
- muScalar :: Lens' MetricUpdate (Maybe JSONValue)
- data SourceGetMetadataResponse
- sourceGetMetadataResponse :: SourceGetMetadataResponse
- sgmrMetadata :: Lens' SourceGetMetadataResponse (Maybe SourceMetadata)
- data Environment
- environment :: Environment
- eDataSet :: Lens' Environment (Maybe Text)
- eExperiments :: Lens' Environment [Text]
- eWorkerPools :: Lens' Environment [WorkerPool]
- eClusterManagerAPIService :: Lens' Environment (Maybe Text)
- eVersion :: Lens' Environment (Maybe EnvironmentVersion)
- eInternalExperiments :: Lens' Environment (Maybe EnvironmentInternalExperiments)
- eTempStoragePrefix :: Lens' Environment (Maybe Text)
- eUserAgent :: Lens' Environment (Maybe EnvironmentUserAgent)
- eSdkPipelineOptions :: Lens' Environment (Maybe EnvironmentSdkPipelineOptions)
- data ConcatPosition
- concatPosition :: ConcatPosition
- cpIndex :: Lens' ConcatPosition (Maybe Int32)
- cpPosition :: Lens' ConcatPosition (Maybe Position)
- data MetricStructuredNameContext
- metricStructuredNameContext :: HashMap Text Text -> MetricStructuredNameContext
- msncAddtional :: Lens' MetricStructuredNameContext (HashMap Text Text)
- data StreamingStageLocation
- streamingStageLocation :: StreamingStageLocation
- sslStreamId :: Lens' StreamingStageLocation (Maybe Text)
- data DerivedSource
- derivedSource :: DerivedSource
- dsDerivationMode :: Lens' DerivedSource (Maybe Text)
- dsSource :: Lens' DerivedSource (Maybe Source)
- data JobMetrics
- jobMetrics :: JobMetrics
- jmMetrics :: Lens' JobMetrics [MetricUpdate]
- jmMetricTime :: Lens' JobMetrics (Maybe Text)
- data WorkItemStatus
- workItemStatus :: WorkItemStatus
- wisReportedProgress :: Lens' WorkItemStatus (Maybe ApproximateReportedProgress)
- wisProgress :: Lens' WorkItemStatus (Maybe ApproximateProgress)
- wisSourceOperationResponse :: Lens' WorkItemStatus (Maybe SourceOperationResponse)
- wisStopPosition :: Lens' WorkItemStatus (Maybe Position)
- wisDynamicSourceSplit :: Lens' WorkItemStatus (Maybe DynamicSourceSplit)
- wisCompleted :: Lens' WorkItemStatus (Maybe Bool)
- wisSourceFork :: Lens' WorkItemStatus (Maybe SourceFork)
- wisReportIndex :: Lens' WorkItemStatus (Maybe Int64)
- wisRequestedLeaseDuration :: Lens' WorkItemStatus (Maybe Text)
- wisErrors :: Lens' WorkItemStatus [Status]
- wisMetricUpdates :: Lens' WorkItemStatus [MetricUpdate]
- wisWorkItemId :: Lens' WorkItemStatus (Maybe Text)
- data WorkerMessageLabels
- workerMessageLabels :: HashMap Text Text -> WorkerMessageLabels
- wmlAddtional :: Lens' WorkerMessageLabels (HashMap Text Text)
- data FlattenInstruction
- flattenInstruction :: FlattenInstruction
- fiInputs :: Lens' FlattenInstruction [InstructionInput]
- data WorkerMessageCode
- workerMessageCode :: WorkerMessageCode
- wmcParameters :: Lens' WorkerMessageCode (Maybe WorkerMessageCodeParameters)
- wmcCode :: Lens' WorkerMessageCode (Maybe Text)
- data JobTransformNameMApping
- jobTransformNameMApping :: HashMap Text Text -> JobTransformNameMApping
- jtnmaAddtional :: Lens' JobTransformNameMApping (HashMap Text Text)
- data SourceSpec
- sourceSpec :: HashMap Text JSONValue -> SourceSpec
- ssAddtional :: Lens' SourceSpec (HashMap Text JSONValue)
- data SourceMetadata
- sourceMetadata :: SourceMetadata
- smEstimatedSizeBytes :: Lens' SourceMetadata (Maybe Int64)
- smProducesSortedKeys :: Lens' SourceMetadata (Maybe Bool)
- smInfinite :: Lens' SourceMetadata (Maybe Bool)
- data EnvironmentInternalExperiments
- environmentInternalExperiments :: HashMap Text JSONValue -> EnvironmentInternalExperiments
- eieAddtional :: Lens' EnvironmentInternalExperiments (HashMap Text JSONValue)
- data TaskRunnerSettings
- taskRunnerSettings :: TaskRunnerSettings
- trsContinueOnException :: Lens' TaskRunnerSettings (Maybe Bool)
- trsHarnessCommand :: Lens' TaskRunnerSettings (Maybe Text)
- trsWorkflowFileName :: Lens' TaskRunnerSettings (Maybe Text)
- trsTaskGroup :: Lens' TaskRunnerSettings (Maybe Text)
- trsAlsologtostderr :: Lens' TaskRunnerSettings (Maybe Bool)
- trsDataflowAPIVersion :: Lens' TaskRunnerSettings (Maybe Text)
- trsLogDir :: Lens' TaskRunnerSettings (Maybe Text)
- trsCommandlinesFileName :: Lens' TaskRunnerSettings (Maybe Text)
- trsVMId :: Lens' TaskRunnerSettings (Maybe Text)
- trsBaseURL :: Lens' TaskRunnerSettings (Maybe Text)
- trsOAuthScopes :: Lens' TaskRunnerSettings [Text]
- trsTaskUser :: Lens' TaskRunnerSettings (Maybe Text)
- trsStreamingWorkerMainClass :: Lens' TaskRunnerSettings (Maybe Text)
- trsBaseTaskDir :: Lens' TaskRunnerSettings (Maybe Text)
- trsLogUploadLocation :: Lens' TaskRunnerSettings (Maybe Text)
- trsTempStoragePrefix :: Lens' TaskRunnerSettings (Maybe Text)
- trsLogToSerialconsole :: Lens' TaskRunnerSettings (Maybe Bool)
- trsParallelWorkerSettings :: Lens' TaskRunnerSettings (Maybe WorkerSettings)
- trsLanguageHint :: Lens' TaskRunnerSettings (Maybe Text)
- data EnvironmentSdkPipelineOptions
- environmentSdkPipelineOptions :: HashMap Text JSONValue -> EnvironmentSdkPipelineOptions
- espoAddtional :: Lens' EnvironmentSdkPipelineOptions (HashMap Text JSONValue)
- data LeaseWorkItemRequest
- leaseWorkItemRequest :: LeaseWorkItemRequest
- lwirWorkItemTypes :: Lens' LeaseWorkItemRequest [Text]
- lwirCurrentWorkerTime :: Lens' LeaseWorkItemRequest (Maybe Text)
- lwirWorkerCapabilities :: Lens' LeaseWorkItemRequest [Text]
- lwirRequestedLeaseDuration :: Lens' LeaseWorkItemRequest (Maybe Text)
- lwirWorkerId :: Lens' LeaseWorkItemRequest (Maybe Text)
- data SourceOperationResponse
- sourceOperationResponse :: SourceOperationResponse
- sorSplit :: Lens' SourceOperationResponse (Maybe SourceSplitResponse)
- sorGetMetadata :: Lens' SourceOperationResponse (Maybe SourceGetMetadataResponse)
- data TopologyConfigUserStageToComputationNameMap
- topologyConfigUserStageToComputationNameMap :: HashMap Text Text -> TopologyConfigUserStageToComputationNameMap
- tcustcnmAddtional :: Lens' TopologyConfigUserStageToComputationNameMap (HashMap Text Text)
- data ShellTask
- shellTask :: ShellTask
- stCommand :: Lens' ShellTask (Maybe Text)
- stExitCode :: Lens' ShellTask (Maybe Int32)
- data StatusDetailsItem
- statusDetailsItem :: HashMap Text JSONValue -> StatusDetailsItem
- sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)
- data ReportedParallelism
- reportedParallelism :: ReportedParallelism
- rpValue :: Lens' ReportedParallelism (Maybe Double)
- rpIsInfinite :: Lens' ReportedParallelism (Maybe Bool)
- data StepProperties
- stepProperties :: HashMap Text JSONValue -> StepProperties
- spAddtional :: Lens' StepProperties (HashMap Text JSONValue)
- data TopologyConfig
- topologyConfig :: TopologyConfig
- tcDataDiskAssignments :: Lens' TopologyConfig [DataDiskAssignment]
- tcPersistentStateVersion :: Lens' TopologyConfig (Maybe Int32)
- tcForwardingKeyBits :: Lens' TopologyConfig (Maybe Int32)
- tcUserStageToComputationNameMap :: Lens' TopologyConfig (Maybe TopologyConfigUserStageToComputationNameMap)
- tcComputations :: Lens' TopologyConfig [ComputationTopology]
- data ApproximateSplitRequest
- approximateSplitRequest :: ApproximateSplitRequest
- asrFractionConsumed :: Lens' ApproximateSplitRequest (Maybe Double)
- asrPosition :: Lens' ApproximateSplitRequest (Maybe Position)
- data WorkerSettings
- workerSettings :: WorkerSettings
- wsServicePath :: Lens' WorkerSettings (Maybe Text)
- wsBaseURL :: Lens' WorkerSettings (Maybe Text)
- wsShuffleServicePath :: Lens' WorkerSettings (Maybe Text)
- wsTempStoragePrefix :: Lens' WorkerSettings (Maybe Text)
- wsReportingEnabled :: Lens' WorkerSettings (Maybe Bool)
- wsWorkerId :: Lens' WorkerSettings (Maybe Text)
- data WorkItemServiceStateHarnessData
- workItemServiceStateHarnessData :: HashMap Text JSONValue -> WorkItemServiceStateHarnessData
- wisshdAddtional :: Lens' WorkItemServiceStateHarnessData (HashMap Text JSONValue)
- data DataDiskAssignment
- dataDiskAssignment :: DataDiskAssignment
- ddaVMInstance :: Lens' DataDiskAssignment (Maybe Text)
- ddaDataDisks :: Lens' DataDiskAssignment [Text]
- data WorkerMessageResponse
- workerMessageResponse :: WorkerMessageResponse
- wmrWorkerHealthReportResponse :: Lens' WorkerMessageResponse (Maybe WorkerHealthReportResponse)
- data WorkItemServiceState
- workItemServiceState :: WorkItemServiceState
- wissNextReportIndex :: Lens' WorkItemServiceState (Maybe Int64)
- wissReportStatusInterval :: Lens' WorkItemServiceState (Maybe Text)
- wissHarnessData :: Lens' WorkItemServiceState (Maybe WorkItemServiceStateHarnessData)
- wissSuggestedStopPoint :: Lens' WorkItemServiceState (Maybe ApproximateProgress)
- wissSuggestedStopPosition :: Lens' WorkItemServiceState (Maybe Position)
- wissLeaseExpireTime :: Lens' WorkItemServiceState (Maybe Text)
- wissSplitRequest :: Lens' WorkItemServiceState (Maybe ApproximateSplitRequest)
- data StreamingSetupTask
- streamingSetupTask :: StreamingSetupTask
- sstStreamingComputationTopology :: Lens' StreamingSetupTask (Maybe TopologyConfig)
- sstReceiveWorkPort :: Lens' StreamingSetupTask (Maybe Int32)
- sstWorkerHarnessPort :: Lens' StreamingSetupTask (Maybe Int32)
- sstDrain :: Lens' StreamingSetupTask (Maybe Bool)
- data PartialGroupByKeyInstructionInputElementCodec
- partialGroupByKeyInstructionInputElementCodec :: HashMap Text JSONValue -> PartialGroupByKeyInstructionInputElementCodec
- pgbkiiecAddtional :: Lens' PartialGroupByKeyInstructionInputElementCodec (HashMap Text JSONValue)
- data MapTask
- mapTask :: MapTask
- mtInstructions :: Lens' MapTask [ParallelInstruction]
- mtSystemName :: Lens' MapTask (Maybe Text)
- mtStageName :: Lens' MapTask (Maybe Text)
- data MountedDataDisk
- mountedDataDisk :: MountedDataDisk
- mddDataDisk :: Lens' MountedDataDisk (Maybe Text)
- data SinkCodec
- sinkCodec :: HashMap Text JSONValue -> SinkCodec
- scAddtional :: Lens' SinkCodec (HashMap Text JSONValue)
- data WorkerHealthReportPodsItem
- workerHealthReportPodsItem :: HashMap Text JSONValue -> WorkerHealthReportPodsItem
- whrpiAddtional :: Lens' WorkerHealthReportPodsItem (HashMap Text JSONValue)
- data ParDoInstructionUserFn
- parDoInstructionUserFn :: HashMap Text JSONValue -> ParDoInstructionUserFn
- pdiufAddtional :: Lens' ParDoInstructionUserFn (HashMap Text JSONValue)
- data InstructionOutputCodec
- instructionOutputCodec :: HashMap Text JSONValue -> InstructionOutputCodec
- iocAddtional :: Lens' InstructionOutputCodec (HashMap Text JSONValue)
- data StreamLocation
- streamLocation :: StreamLocation
- slStreamingStageLocation :: Lens' StreamLocation (Maybe StreamingStageLocation)
- slSideInputLocation :: Lens' StreamLocation (Maybe StreamingSideInputLocation)
- slCustomSourceLocation :: Lens' StreamLocation (Maybe CustomSourceLocation)
- slPubsubLocation :: Lens' StreamLocation (Maybe PubsubLocation)
- data WorkerPoolPoolArgs
- workerPoolPoolArgs :: HashMap Text JSONValue -> WorkerPoolPoolArgs
- wppaAddtional :: Lens' WorkerPoolPoolArgs (HashMap Text JSONValue)
- data SendWorkerMessagesResponse
- sendWorkerMessagesResponse :: SendWorkerMessagesResponse
- swmrWorkerMessageResponses :: Lens' SendWorkerMessagesResponse [WorkerMessageResponse]
- data StreamingSideInputLocation
- streamingSideInputLocation :: StreamingSideInputLocation
- ssilTag :: Lens' StreamingSideInputLocation (Maybe Text)
- ssilStateFamily :: Lens' StreamingSideInputLocation (Maybe Text)
- data StreamingComputationTask
- streamingComputationTask :: StreamingComputationTask
- sctTaskType :: Lens' StreamingComputationTask (Maybe Text)
- sctDataDisks :: Lens' StreamingComputationTask [MountedDataDisk]
- sctComputationRanges :: Lens' StreamingComputationTask [StreamingComputationRanges]
- data JobMessage
- jobMessage :: JobMessage
- jmTime :: Lens' JobMessage (Maybe Text)
- jmMessageText :: Lens' JobMessage (Maybe Text)
- jmMessageImportance :: Lens' JobMessage (Maybe Text)
- jmId :: Lens' JobMessage (Maybe Text)
- data SeqMapTaskOutputInfo
- seqMapTaskOutputInfo :: SeqMapTaskOutputInfo
- smtoiSink :: Lens' SeqMapTaskOutputInfo (Maybe Sink)
- smtoiTag :: Lens' SeqMapTaskOutputInfo (Maybe Text)
- data SourceGetMetadataRequest
- sourceGetMetadataRequest :: SourceGetMetadataRequest
- sgmrSource :: Lens' SourceGetMetadataRequest (Maybe Source)
- data SeqMapTaskUserFn
- seqMapTaskUserFn :: HashMap Text JSONValue -> SeqMapTaskUserFn
- smtufAddtional :: Lens' SeqMapTaskUserFn (HashMap Text JSONValue)
- data PartialGroupByKeyInstructionValueCombiningFn
- partialGroupByKeyInstructionValueCombiningFn :: HashMap Text JSONValue -> PartialGroupByKeyInstructionValueCombiningFn
- pgbkivcfAddtional :: Lens' PartialGroupByKeyInstructionValueCombiningFn (HashMap Text JSONValue)
- data Job
- job :: Job
- jRequestedState :: Lens' Job (Maybe Text)
- jEnvironment :: Lens' Job (Maybe Environment)
- jClientRequestId :: Lens' Job (Maybe Text)
- jCurrentState :: Lens' Job (Maybe Text)
- jReplacedByJobId :: Lens' Job (Maybe Text)
- jTempFiles :: Lens' Job [Text]
- jSteps :: Lens' Job [Step]
- jExecutionInfo :: Lens' Job (Maybe JobExecutionInfo)
- jName :: Lens' Job (Maybe Text)
- jTransformNameMApping :: Lens' Job (Maybe JobTransformNameMApping)
- jId :: Lens' Job (Maybe Text)
- jProjectId :: Lens' Job (Maybe Text)
- jType :: Lens' Job (Maybe Text)
- jCurrentStateTime :: Lens' Job (Maybe Text)
- jReplaceJobId :: Lens' Job (Maybe Text)
- jCreateTime :: Lens' Job (Maybe Text)
- data ReadInstruction
- readInstruction :: ReadInstruction
- riSource :: Lens' ReadInstruction (Maybe Source)
- data ApproximateReportedProgress
- approximateReportedProgress :: ApproximateReportedProgress
- arpFractionConsumed :: Lens' ApproximateReportedProgress (Maybe Double)
- arpConsumedParallelism :: Lens' ApproximateReportedProgress (Maybe ReportedParallelism)
- arpRemainingParallelism :: Lens' ApproximateReportedProgress (Maybe ReportedParallelism)
- arpPosition :: Lens' ApproximateReportedProgress (Maybe Position)
- data SinkSpec
- sinkSpec :: HashMap Text JSONValue -> SinkSpec
- sAddtional :: Lens' SinkSpec (HashMap Text JSONValue)
- data WorkerPool
- workerPool :: WorkerPool
- wpAutoscalingSettings :: Lens' WorkerPool (Maybe AutoscalingSettings)
- wpNumThreadsPerWorker :: Lens' WorkerPool (Maybe Int32)
- wpDiskSizeGb :: Lens' WorkerPool (Maybe Int32)
- wpKind :: Lens' WorkerPool (Maybe Text)
- wpTaskrunnerSettings :: Lens' WorkerPool (Maybe TaskRunnerSettings)
- wpNumWorkers :: Lens' WorkerPool (Maybe Int32)
- wpNetwork :: Lens' WorkerPool (Maybe Text)
- wpZone :: Lens' WorkerPool (Maybe Text)
- wpPackages :: Lens' WorkerPool [Package]
- wpOnHostMaintenance :: Lens' WorkerPool (Maybe Text)
- wpDiskSourceImage :: Lens' WorkerPool (Maybe Text)
- wpSubnetwork :: Lens' WorkerPool (Maybe Text)
- wpMachineType :: Lens' WorkerPool (Maybe Text)
- wpMetadata :: Lens' WorkerPool (Maybe WorkerPoolMetadata)
- wpDiskType :: Lens' WorkerPool (Maybe Text)
- wpTeardownPolicy :: Lens' WorkerPool (Maybe Text)
- wpDefaultPackageSet :: Lens' WorkerPool (Maybe Text)
- wpPoolArgs :: Lens' WorkerPool (Maybe WorkerPoolPoolArgs)
- wpWorkerHarnessContainerImage :: Lens' WorkerPool (Maybe Text)
- wpDataDisks :: Lens' WorkerPool [Disk]
- data Step
- step :: Step
- sKind :: Lens' Step (Maybe Text)
- sName :: Lens' Step (Maybe Text)
- sProperties :: Lens' Step (Maybe StepProperties)
- data Package
- package :: Package
- pLocation :: Lens' Package (Maybe Text)
- pName :: Lens' Package (Maybe Text)
- data WorkerMessageCodeParameters
- workerMessageCodeParameters :: HashMap Text JSONValue -> WorkerMessageCodeParameters
- wmcpAddtional :: Lens' WorkerMessageCodeParameters (HashMap Text JSONValue)
- data DynamicSourceSplit
- dynamicSourceSplit :: DynamicSourceSplit
- dssResidual :: Lens' DynamicSourceSplit (Maybe DerivedSource)
- dssPrimary :: Lens' DynamicSourceSplit (Maybe DerivedSource)
- data ReportWorkItemStatusResponse
- reportWorkItemStatusResponse :: ReportWorkItemStatusResponse
- rwisrWorkItemServiceStates :: Lens' ReportWorkItemStatusResponse [WorkItemServiceState]
- data SourceFork
- sourceFork :: SourceFork
- sfResidual :: Lens' SourceFork (Maybe SourceSplitShard)
- sfPrimarySource :: Lens' SourceFork (Maybe DerivedSource)
- sfPrimary :: Lens' SourceFork (Maybe SourceSplitShard)
- sfResidualSource :: Lens' SourceFork (Maybe DerivedSource)
- data StreamingComputationRanges
- streamingComputationRanges :: StreamingComputationRanges
- scrRangeAssignments :: Lens' StreamingComputationRanges [KeyRangeDataDiskAssignment]
- scrComputationId :: Lens' StreamingComputationRanges (Maybe Text)
- data ListJobsResponse
- listJobsResponse :: ListJobsResponse
- ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text)
- ljrJobs :: Lens' ListJobsResponse [Job]
- data Source
- source :: Source
- souDoesNotNeedSplitting :: Lens' Source (Maybe Bool)
- souBaseSpecs :: Lens' Source [SourceBaseSpecsItem]
- souCodec :: Lens' Source (Maybe SourceCodec)
- souSpec :: Lens' Source (Maybe SourceSpec)
- souMetadata :: Lens' Source (Maybe SourceMetadata)
- data ApproximateProgress
- approximateProgress :: ApproximateProgress
- apRemainingTime :: Lens' ApproximateProgress (Maybe Text)
- apPercentComplete :: Lens' ApproximateProgress (Maybe Double)
- apPosition :: Lens' ApproximateProgress (Maybe Position)
- data WorkerMessage
- workerMessage :: WorkerMessage
- wmWorkerHealthReport :: Lens' WorkerMessage (Maybe WorkerHealthReport)
- wmTime :: Lens' WorkerMessage (Maybe Text)
- wmWorkerMessageCode :: Lens' WorkerMessage (Maybe WorkerMessageCode)
- wmLabels :: Lens' WorkerMessage (Maybe WorkerMessageLabels)
- data KeyRangeLocation
- keyRangeLocation :: KeyRangeLocation
- krlPersistentDirectory :: Lens' KeyRangeLocation (Maybe Text)
- krlDataDisk :: Lens' KeyRangeLocation (Maybe Text)
- krlStart :: Lens' KeyRangeLocation (Maybe Text)
- krlDeliveryEndpoint :: Lens' KeyRangeLocation (Maybe Text)
- krlEnd :: Lens' KeyRangeLocation (Maybe Text)
- data MultiOutputInfo
- multiOutputInfo :: MultiOutputInfo
- moiTag :: Lens' MultiOutputInfo (Maybe Text)
- data PartialGroupByKeyInstruction
- partialGroupByKeyInstruction :: PartialGroupByKeyInstruction
- pgbkiValueCombiningFn :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionValueCombiningFn)
- pgbkiSideInputs :: Lens' PartialGroupByKeyInstruction [SideInputInfo]
- pgbkiInput :: Lens' PartialGroupByKeyInstruction (Maybe InstructionInput)
- pgbkiInputElementCodec :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionInputElementCodec)
- data ParDoInstruction
- parDoInstruction :: ParDoInstruction
- pdiNumOutputs :: Lens' ParDoInstruction (Maybe Int32)
- pdiMultiOutputInfos :: Lens' ParDoInstruction [MultiOutputInfo]
- pdiSideInputs :: Lens' ParDoInstruction [SideInputInfo]
- pdiInput :: Lens' ParDoInstruction (Maybe InstructionInput)
- pdiUserFn :: Lens' ParDoInstruction (Maybe ParDoInstructionUserFn)
- data CustomSourceLocation
- customSourceLocation :: CustomSourceLocation
- cslStateful :: Lens' CustomSourceLocation (Maybe Bool)
- data SourceBaseSpecsItem
- sourceBaseSpecsItem :: HashMap Text JSONValue -> SourceBaseSpecsItem
- sbsiAddtional :: Lens' SourceBaseSpecsItem (HashMap Text JSONValue)
- data ParallelInstruction
- parallelInstruction :: ParallelInstruction
- piRead :: Lens' ParallelInstruction (Maybe ReadInstruction)
- piWrite :: Lens' ParallelInstruction (Maybe WriteInstruction)
- piParDo :: Lens' ParallelInstruction (Maybe ParDoInstruction)
- piPartialGroupByKey :: Lens' ParallelInstruction (Maybe PartialGroupByKeyInstruction)
- piOutputs :: Lens' ParallelInstruction [InstructionOutput]
- piName :: Lens' ParallelInstruction (Maybe Text)
- piSystemName :: Lens' ParallelInstruction (Maybe Text)
- piFlatten :: Lens' ParallelInstruction (Maybe FlattenInstruction)
- data SideInputInfoKind
- sideInputInfoKind :: HashMap Text JSONValue -> SideInputInfoKind
- siikAddtional :: Lens' SideInputInfoKind (HashMap Text JSONValue)
- data SendWorkerMessagesRequest
- sendWorkerMessagesRequest :: SendWorkerMessagesRequest
- swmrWorkerMessages :: Lens' SendWorkerMessagesRequest [WorkerMessage]
- data SourceSplitShard
- sourceSplitShard :: SourceSplitShard
- sssDerivationMode :: Lens' SourceSplitShard (Maybe Text)
- sssSource :: Lens' SourceSplitShard (Maybe Source)
- data SideInputInfo
- sideInputInfo :: SideInputInfo
- siiTag :: Lens' SideInputInfo (Maybe Text)
- siiKind :: Lens' SideInputInfo (Maybe SideInputInfoKind)
- siiSources :: Lens' SideInputInfo [Source]
- data JobExecutionInfo
- jobExecutionInfo :: JobExecutionInfo
- jeiStages :: Lens' JobExecutionInfo (Maybe JobExecutionInfoStages)
- data SourceCodec
- sourceCodec :: HashMap Text JSONValue -> SourceCodec
- souAddtional :: Lens' SourceCodec (HashMap Text JSONValue)
- data StateFamilyConfig
- stateFamilyConfig :: StateFamilyConfig
- sfcIsRead :: Lens' StateFamilyConfig (Maybe Bool)
- sfcStateFamily :: Lens' StateFamilyConfig (Maybe Text)
- data KeyRangeDataDiskAssignment
- keyRangeDataDiskAssignment :: KeyRangeDataDiskAssignment
- krddaDataDisk :: Lens' KeyRangeDataDiskAssignment (Maybe Text)
- krddaStart :: Lens' KeyRangeDataDiskAssignment (Maybe Text)
- krddaEnd :: Lens' KeyRangeDataDiskAssignment (Maybe Text)
- data SourceSplitRequest
- sourceSplitRequest :: SourceSplitRequest
- ssrSource :: Lens' SourceSplitRequest (Maybe Source)
- ssrOptions :: Lens' SourceSplitRequest (Maybe SourceSplitOptions)
- data ListJobMessagesResponse
- listJobMessagesResponse :: ListJobMessagesResponse
- ljmrJobMessages :: Lens' ListJobMessagesResponse [JobMessage]
- ljmrNextPageToken :: Lens' ListJobMessagesResponse (Maybe Text)
- data PubsubLocation
- pubsubLocation :: PubsubLocation
- plTrackingSubscription :: Lens' PubsubLocation (Maybe Text)
- plDropLateData :: Lens' PubsubLocation (Maybe Bool)
- plTimestampLabel :: Lens' PubsubLocation (Maybe Text)
- plIdLabel :: Lens' PubsubLocation (Maybe Text)
- plTopic :: Lens' PubsubLocation (Maybe Text)
- plSubscription :: Lens' PubsubLocation (Maybe Text)
- data InstructionInput
- instructionInput :: InstructionInput
- iiProducerInstructionIndex :: Lens' InstructionInput (Maybe Int32)
- iiOutputNum :: Lens' InstructionInput (Maybe Int32)
- data SeqMapTask
- seqMapTask :: SeqMapTask
- smtInputs :: Lens' SeqMapTask [SideInputInfo]
- smtName :: Lens' SeqMapTask (Maybe Text)
- smtOutputInfos :: Lens' SeqMapTask [SeqMapTaskOutputInfo]
- smtSystemName :: Lens' SeqMapTask (Maybe Text)
- smtStageName :: Lens' SeqMapTask (Maybe Text)
- smtUserFn :: Lens' SeqMapTask (Maybe SeqMapTaskUserFn)
- data SourceOperationRequest
- sourceOperationRequest :: SourceOperationRequest
- sSplit :: Lens' SourceOperationRequest (Maybe SourceSplitRequest)
- sGetMetadata :: Lens' SourceOperationRequest (Maybe SourceGetMetadataRequest)
- data LeaseWorkItemResponse
- leaseWorkItemResponse :: LeaseWorkItemResponse
- lwirWorkItems :: Lens' LeaseWorkItemResponse [WorkItem]
- data Position
- position :: Position
- pByteOffSet :: Lens' Position (Maybe Int64)
- pConcatPosition :: Lens' Position (Maybe ConcatPosition)
- pRecordIndex :: Lens' Position (Maybe Int64)
- pShufflePosition :: Lens' Position (Maybe Text)
- pKey :: Lens' Position (Maybe Text)
- pEnd :: Lens' Position (Maybe Bool)
Service Configuration
dataflowService :: ServiceConfig Source #
Default request referring to version v1b3
of the Google Dataflow API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
userInfoEmailScope :: Proxy '["https://www.googleapis.com/auth/userinfo.email"] Source #
View your email address
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
API Declaration
type DataflowAPI = ProjectsJobsWorkItemsLeaseResource :<|> (ProjectsJobsWorkItemsReportStatusResource :<|> (ProjectsJobsMessagesListResource :<|> (ProjectsJobsListResource :<|> (ProjectsJobsGetResource :<|> (ProjectsJobsCreateResource :<|> (ProjectsJobsUpdateResource :<|> (ProjectsJobsGetMetricsResource :<|> ProjectsWorkerMessagesResource))))))) Source #
Represents the entirety of the methods and resources available for the Google Dataflow API service.
Resources
dataflow.projects.jobs.create
dataflow.projects.jobs.get
dataflow.projects.jobs.getMetrics
dataflow.projects.jobs.list
dataflow.projects.jobs.messages.list
dataflow.projects.jobs.update
dataflow.projects.jobs.workItems.lease
dataflow.projects.jobs.workItems.reportStatus
dataflow.projects.workerMessages
Types
JobExecutionInfoStages
data JobExecutionInfoStages Source #
A mapping from each stage to the information about that stage.
See: jobExecutionInfoStages
smart constructor.
jobExecutionInfoStages Source #
Creates a value of JobExecutionInfoStages
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ComputationTopology
data ComputationTopology Source #
All configuration data for a particular Computation.
See: computationTopology
smart constructor.
computationTopology :: ComputationTopology Source #
Creates a value of ComputationTopology
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctStateFamilies :: Lens' ComputationTopology [StateFamilyConfig] Source #
The state family values.
ctUserStageName :: Lens' ComputationTopology (Maybe Text) Source #
The user stage name.
ctInputs :: Lens' ComputationTopology [StreamLocation] Source #
The inputs to the computation.
ctKeyRanges :: Lens' ComputationTopology [KeyRangeLocation] Source #
The key ranges processed by the computation.
ctOutputs :: Lens' ComputationTopology [StreamLocation] Source #
The outputs from the computation.
ctComputationId :: Lens' ComputationTopology (Maybe Text) Source #
The ID of the computation.
ctSystemStageName :: Lens' ComputationTopology (Maybe Text) Source #
The system stage name.
SourceSplitResponse
data SourceSplitResponse Source #
The response to a SourceSplitRequest.
See: sourceSplitResponse
smart constructor.
sourceSplitResponse :: SourceSplitResponse Source #
Creates a value of SourceSplitResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssrBundles :: Lens' SourceSplitResponse [DerivedSource] Source #
If outcome is SPLITTING_HAPPENED, then this is a list of bundles into which the source was split. Otherwise this field is ignored. This list can be empty, which means the source represents an empty input.
ssrShards :: Lens' SourceSplitResponse [SourceSplitShard] Source #
DEPRECATED in favor of bundles.
ssrOutcome :: Lens' SourceSplitResponse (Maybe Text) Source #
Indicates whether splitting happened and produced a list of bundles. If this is USE_CURRENT_SOURCE_AS_IS, the current source should be processed "as is" without splitting. "bundles" is ignored in this case. If this is SPLITTING_HAPPENED, then "bundles" contains a list of bundles into which the source was split.
Status
The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.
See: status
smart constructor.
sDetails :: Lens' Status [StatusDetailsItem] Source #
A list of messages that carry the error details. There will be a common set of message types for APIs to use.
sCode :: Lens' Status (Maybe Int32) Source #
The status code, which should be an enum value of google.rpc.Code.
sMessage :: Lens' Status (Maybe Text) Source #
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
WorkItem
WorkItem represents basic information about a WorkItem to be executed in the cloud.
See: workItem
smart constructor.
Creates a value of WorkItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wiJobId :: Lens' WorkItem (Maybe Text) Source #
Identifies the workflow job this WorkItem belongs to.
wiShellTask :: Lens' WorkItem (Maybe ShellTask) Source #
Additional information for ShellTask WorkItems.
wiStreamingSetupTask :: Lens' WorkItem (Maybe StreamingSetupTask) Source #
Additional information for StreamingSetupTask WorkItems.
wiInitialReportIndex :: Lens' WorkItem (Maybe Int64) Source #
The initial index to use when reporting the status of the WorkItem.
wiPackages :: Lens' WorkItem [Package] Source #
Any required packages that need to be fetched in order to execute this WorkItem.
wiStreamingComputationTask :: Lens' WorkItem (Maybe StreamingComputationTask) Source #
Additional information for StreamingComputationTask WorkItems.
wiSourceOperationTask :: Lens' WorkItem (Maybe SourceOperationRequest) Source #
Additional information for source operation WorkItems.
wiProjectId :: Lens' WorkItem (Maybe Text) Source #
Identifies the cloud project this WorkItem belongs to.
wiLeaseExpireTime :: Lens' WorkItem (Maybe Text) Source #
Time when the lease on this Work will expire.
wiConfiguration :: Lens' WorkItem (Maybe Text) Source #
Work item-specific configuration as an opaque blob.
wiSeqMapTask :: Lens' WorkItem (Maybe SeqMapTask) Source #
Additional information for SeqMapTask WorkItems.
WorkerHealthReport
data WorkerHealthReport Source #
WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to.
See: workerHealthReport
smart constructor.
workerHealthReport :: WorkerHealthReport Source #
Creates a value of WorkerHealthReport
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
whrVMIsHealthy :: Lens' WorkerHealthReport (Maybe Bool) Source #
Whether the VM is healthy.
whrReportInterval :: Lens' WorkerHealthReport (Maybe Text) Source #
The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker.
whrPods :: Lens' WorkerHealthReport [WorkerHealthReportPodsItem] Source #
The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker.
whrVMStartupTime :: Lens' WorkerHealthReport (Maybe Text) Source #
The time the VM was booted.
SourceSplitOptions
data SourceSplitOptions Source #
Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest.
See: sourceSplitOptions
smart constructor.
sourceSplitOptions :: SourceSplitOptions Source #
Creates a value of SourceSplitOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssoDesiredShardSizeBytes :: Lens' SourceSplitOptions (Maybe Int64) Source #
DEPRECATED in favor of desired_bundle_size_bytes.
ssoDesiredBundleSizeBytes :: Lens' SourceSplitOptions (Maybe Int64) Source #
The source should be split into a set of bundles where the estimated size of each is approximately this many bytes.
WorkerPoolMetadata
data WorkerPoolMetadata Source #
Metadata to set on the Google Compute Engine VMs.
See: workerPoolMetadata
smart constructor.
Creates a value of WorkerPoolMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
AutoscalingSettings
data AutoscalingSettings Source #
Settings for WorkerPool autoscaling.
See: autoscalingSettings
smart constructor.
autoscalingSettings :: AutoscalingSettings Source #
Creates a value of AutoscalingSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asMaxNumWorkers :: Lens' AutoscalingSettings (Maybe Int32) Source #
The maximum number of workers to cap scaling at.
asAlgorithm :: Lens' AutoscalingSettings (Maybe Text) Source #
The algorithm to use for autoscaling.
JobExecutionStageInfo
data JobExecutionStageInfo Source #
Contains information about how a particular google.dataflow.v1beta3.Step will be executed.
See: jobExecutionStageInfo
smart constructor.
jobExecutionStageInfo :: JobExecutionStageInfo Source #
Creates a value of JobExecutionStageInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jesiStepName :: Lens' JobExecutionStageInfo [Text] Source #
The steps associated with the execution stage. Note that stages may have several steps, and that a given step might be run by more than one stage.
InstructionOutput
data InstructionOutput Source #
An output of an instruction.
See: instructionOutput
smart constructor.
instructionOutput :: InstructionOutput Source #
Creates a value of InstructionOutput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ioCodec :: Lens' InstructionOutput (Maybe InstructionOutputCodec) Source #
The codec to use to encode data being written via this output.
ioSystemName :: Lens' InstructionOutput (Maybe Text) Source #
System-defined name of this output. Unique across the workflow.
ReportWorkItemStatusRequest
data ReportWorkItemStatusRequest Source #
Request to report the status of WorkItems.
See: reportWorkItemStatusRequest
smart constructor.
reportWorkItemStatusRequest :: ReportWorkItemStatusRequest Source #
Creates a value of ReportWorkItemStatusRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rwisrCurrentWorkerTime :: Lens' ReportWorkItemStatusRequest (Maybe Text) Source #
The current timestamp at the worker.
rwisrWorkItemStatuses :: Lens' ReportWorkItemStatusRequest [WorkItemStatus] Source #
The order is unimportant, except that the order of the WorkItemServiceState messages in the ReportWorkItemStatusResponse corresponds to the order of WorkItemStatus messages here.
rwisrWorkerId :: Lens' ReportWorkItemStatusRequest (Maybe Text) Source #
The ID of the worker reporting the WorkItem status. If this does not match the ID of the worker which the Dataflow service believes currently has the lease on the WorkItem, the report will be dropped (with an error response).
EnvironmentVersion
data EnvironmentVersion Source #
A structure describing which components and their versions of the service are required in order to run the job.
See: environmentVersion
smart constructor.
Creates a value of EnvironmentVersion
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evAddtional :: Lens' EnvironmentVersion (HashMap Text JSONValue) Source #
Properties of the object.
Sink
A sink that records can be encoded and written to.
See: sink
smart constructor.
WorkerHealthReportResponse
data WorkerHealthReportResponse Source #
WorkerHealthReportResponse contains information returned to the worker in response to a health ping.
See: workerHealthReportResponse
smart constructor.
workerHealthReportResponse :: WorkerHealthReportResponse Source #
Creates a value of WorkerHealthReportResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
whrrReportInterval :: Lens' WorkerHealthReportResponse (Maybe Text) Source #
A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server.
MetricStructuredName
data MetricStructuredName Source #
Identifies a metric, by describing the source which generated the metric.
See: metricStructuredName
smart constructor.
metricStructuredName :: MetricStructuredName Source #
Creates a value of MetricStructuredName
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
msnOrigin :: Lens' MetricStructuredName (Maybe Text) Source #
Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.
msnContext :: Lens' MetricStructuredName (Maybe MetricStructuredNameContext) Source #
Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = .
WriteInstruction
data WriteInstruction Source #
An instruction that writes records. Takes one input, produces no outputs.
See: writeInstruction
smart constructor.
writeInstruction :: WriteInstruction Source #
Creates a value of WriteInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wiInput :: Lens' WriteInstruction (Maybe InstructionInput) Source #
The input.
EnvironmentUserAgent
data EnvironmentUserAgent Source #
A description of the process that generated the request.
See: environmentUserAgent
smart constructor.
Creates a value of EnvironmentUserAgent
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
euaAddtional :: Lens' EnvironmentUserAgent (HashMap Text JSONValue) Source #
Properties of the object.
Disk
Describes the data disk used by a workflow job.
See: disk
smart constructor.
Creates a value of Disk
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dSizeGb :: Lens' Disk (Maybe Int32) Source #
Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
dDiskType :: Lens' Disk (Maybe Text) Source #
Disk storage type, as defined by Google Compute Engine. This must be a disk type appropriate to the project and zone in which the workers will run. If unknown or unspecified, the service will attempt to choose a reasonable default. For example, the standard persistent disk type is a resource name typically ending in "pd-standard". If SSD persistent disks are available, the resource name typically ends with "pd-ssd". The actual valid values are defined the Google Compute Engine API, not by the Dataflow API; consult the Google Compute Engine documentation for more information about determining the set of available disk types for a particular project and zone. Google Compute Engine Disk types are local to a particular project in a particular zone, and so the resource name will typically look something like this: compute.googleapis.com/projects/ /zones//diskTypes/pd-standard
MetricUpdate
data MetricUpdate Source #
Describes the state of a metric.
See: metricUpdate
smart constructor.
metricUpdate :: MetricUpdate Source #
Creates a value of MetricUpdate
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
muMeanSum :: Lens' MetricUpdate (Maybe JSONValue) Source #
Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double.
muInternal :: Lens' MetricUpdate (Maybe JSONValue) Source #
Worker-computed aggregate value for internal use by the Dataflow service.
muSet :: Lens' MetricUpdate (Maybe JSONValue) Source #
Worker-computed aggregate value for the "Set" aggregation kind. The only possible value type is a list of Values whose type can be Long, Double, or String, according to the metric's type. All Values in the list must be of the same type.
muCumulative :: Lens' MetricUpdate (Maybe Bool) Source #
True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem.
muKind :: Lens' MetricUpdate (Maybe Text) Source #
Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", and "Or". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.
muUpdateTime :: Lens' MetricUpdate (Maybe Text) Source #
Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.
muMeanCount :: Lens' MetricUpdate (Maybe JSONValue) Source #
Worker-computed aggregate value for the "Mean" aggregation kind. This holds the count of the aggregated values and is used in combination with mean_sum above to obtain the actual mean aggregate value. The only possible value type is Long.
muName :: Lens' MetricUpdate (Maybe MetricStructuredName) Source #
Name of the metric.
muScalar :: Lens' MetricUpdate (Maybe JSONValue) Source #
Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.
SourceGetMetadataResponse
data SourceGetMetadataResponse Source #
The result of a SourceGetMetadataOperation.
See: sourceGetMetadataResponse
smart constructor.
sourceGetMetadataResponse :: SourceGetMetadataResponse Source #
Creates a value of SourceGetMetadataResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sgmrMetadata :: Lens' SourceGetMetadataResponse (Maybe SourceMetadata) Source #
The computed metadata.
Environment
data Environment Source #
Describes the environment in which a Dataflow Job runs.
See: environment
smart constructor.
environment :: Environment Source #
Creates a value of Environment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eDataSet :: Lens' Environment (Maybe Text) Source #
The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}
eExperiments :: Lens' Environment [Text] Source #
The list of experiments to enable.
eWorkerPools :: Lens' Environment [WorkerPool] Source #
Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.
eClusterManagerAPIService :: Lens' Environment (Maybe Text) Source #
The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
eVersion :: Lens' Environment (Maybe EnvironmentVersion) Source #
A structure describing which components and their versions of the service are required in order to run the job.
eInternalExperiments :: Lens' Environment (Maybe EnvironmentInternalExperiments) Source #
Experimental settings.
eTempStoragePrefix :: Lens' Environment (Maybe Text) Source #
The prefix of the resources the system should use for temporary storage. The system will append the suffix "/temp-{JOBNAME} to this resource prefix, where {JOBNAME} is the value of the job_name field. The resulting bucket and object prefix is used as the prefix of the resources used to store temporary data needed during the job execution. NOTE: This will override the value in taskrunner_settings. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
eUserAgent :: Lens' Environment (Maybe EnvironmentUserAgent) Source #
A description of the process that generated the request.
eSdkPipelineOptions :: Lens' Environment (Maybe EnvironmentSdkPipelineOptions) Source #
The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
ConcatPosition
data ConcatPosition Source #
A position that encapsulates an inner position and an index for the inner position. A ConcatPosition can be used by a reader of a source that encapsulates a set of other sources.
See: concatPosition
smart constructor.
concatPosition :: ConcatPosition Source #
Creates a value of ConcatPosition
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpPosition :: Lens' ConcatPosition (Maybe Position) Source #
Position within the inner source.
MetricStructuredNameContext
data MetricStructuredNameContext Source #
Zero or more labeled fields which identify the part of the job this metric is associated with, such as the name of a step or collection. For example, built-in counters associated with steps will have context['step'] = . Counters associated with PCollections in the SDK will have context['pcollection'] = .
See: metricStructuredNameContext
smart constructor.
metricStructuredNameContext Source #
Creates a value of MetricStructuredNameContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
StreamingStageLocation
data StreamingStageLocation Source #
Identifies the location of a streaming computation stage, for stage-to-stage communication.
See: streamingStageLocation
smart constructor.
streamingStageLocation :: StreamingStageLocation Source #
Creates a value of StreamingStageLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sslStreamId :: Lens' StreamingStageLocation (Maybe Text) Source #
Identifies the particular stream within the streaming Dataflow job.
DerivedSource
data DerivedSource Source #
Specification of one of the bundles produced as a result of splitting a Source (e.g. when executing a SourceSplitRequest, or when splitting an active task using WorkItemStatus.dynamic_source_split), relative to the source being split.
See: derivedSource
smart constructor.
derivedSource :: DerivedSource Source #
Creates a value of DerivedSource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsDerivationMode :: Lens' DerivedSource (Maybe Text) Source #
What source to base the produced source on (if any).
JobMetrics
data JobMetrics Source #
JobMetrics contains a collection of metrics descibing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring.
See: jobMetrics
smart constructor.
jobMetrics :: JobMetrics Source #
Creates a value of JobMetrics
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jmMetrics :: Lens' JobMetrics [MetricUpdate] Source #
All metrics for this job.
jmMetricTime :: Lens' JobMetrics (Maybe Text) Source #
Timestamp as of which metric values are current.
WorkItemStatus
data WorkItemStatus Source #
Conveys a worker's progress through the work described by a WorkItem.
See: workItemStatus
smart constructor.
workItemStatus :: WorkItemStatus Source #
Creates a value of WorkItemStatus
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wisReportedProgress :: Lens' WorkItemStatus (Maybe ApproximateReportedProgress) Source #
The worker's progress through this WorkItem.
wisProgress :: Lens' WorkItemStatus (Maybe ApproximateProgress) Source #
DEPRECATED in favor of reported_progress.
wisSourceOperationResponse :: Lens' WorkItemStatus (Maybe SourceOperationResponse) Source #
If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.
wisStopPosition :: Lens' WorkItemStatus (Maybe Position) Source #
A worker may split an active map task in two parts, "primary" and "residual", continuing to process the primary part and returning the residual part into the pool of available work. This event is called a "dynamic split" and is critical to the dynamic work rebalancing feature. The two obtained sub-tasks are called "parts" of the split. The parts, if concatenated, must represent the same input as would be read by the current task if the split did not happen. The exact way in which the original task is decomposed into the two parts is specified either as a position demarcating them (stop_position), or explicitly as two DerivedSources, if this task consumes a user-defined source type (dynamic_source_split). The "current" task is adjusted as a result of the split: after a task with range [A, B) sends a stop_position update at C, its range is considered to be [A, C), e.g.: * Progress should be interpreted relative to the new range, e.g. "75% completed" means "75% of [A, C) completed" * The worker should interpret proposed_stop_position relative to the new range, e.g. "split at 68%" should be interpreted as "split at 68% of [A, C)". * If the worker chooses to split again using stop_position, only stop_positions in [A, C) will be accepted. * Etc. dynamic_source_split has similar semantics: e.g., if a task with source S splits using dynamic_source_split into {P, R} (where P and R must be together equivalent to S), then subsequent progress and proposed_stop_position should be interpreted relative to P, and in a potential subsequent dynamic_source_split into {P', R'}, P' and R' must be together equivalent to P, etc.
wisDynamicSourceSplit :: Lens' WorkItemStatus (Maybe DynamicSourceSplit) Source #
See documentation of stop_position.
wisCompleted :: Lens' WorkItemStatus (Maybe Bool) Source #
True if the WorkItem was completed (successfully or unsuccessfully).
wisSourceFork :: Lens' WorkItemStatus (Maybe SourceFork) Source #
DEPRECATED in favor of dynamic_source_split.
wisReportIndex :: Lens' WorkItemStatus (Maybe Int64) Source #
The report index. When a WorkItem is leased, the lease will contain an initial report index. When a WorkItem's status is reported to the system, the report should be sent with that report index, and the response will contain the index the worker should use for the next report. Reports received with unexpected index values will be rejected by the service. In order to preserve idempotency, the worker should not alter the contents of a report, even if the worker must submit the same report multiple times before getting back a response. The worker should not submit a subsequent report until the response for the previous report had been received from the service.
wisRequestedLeaseDuration :: Lens' WorkItemStatus (Maybe Text) Source #
Amount of time the worker requests for its lease.
wisErrors :: Lens' WorkItemStatus [Status] Source #
Specifies errors which occurred during processing. If errors are provided, and completed = true, then the WorkItem is considered to have failed.
wisMetricUpdates :: Lens' WorkItemStatus [MetricUpdate] Source #
Worker output metrics (counters) for this WorkItem.
wisWorkItemId :: Lens' WorkItemStatus (Maybe Text) Source #
Identifies the WorkItem.
WorkerMessageLabels
data WorkerMessageLabels Source #
Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
See: workerMessageLabels
smart constructor.
Creates a value of WorkerMessageLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FlattenInstruction
data FlattenInstruction Source #
An instruction that copies its inputs (zero or more) to its (single) output.
See: flattenInstruction
smart constructor.
flattenInstruction :: FlattenInstruction Source #
Creates a value of FlattenInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fiInputs :: Lens' FlattenInstruction [InstructionInput] Source #
Describes the inputs to the flatten instruction.
WorkerMessageCode
data WorkerMessageCode Source #
A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure).
See: workerMessageCode
smart constructor.
workerMessageCode :: WorkerMessageCode Source #
Creates a value of WorkerMessageCode
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wmcParameters :: Lens' WorkerMessageCode (Maybe WorkerMessageCodeParameters) Source #
Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
wmcCode :: Lens' WorkerMessageCode (Maybe Text) Source #
The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a GCS file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change.
JobTransformNameMApping
data JobTransformNameMApping Source #
Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
See: jobTransformNameMApping
smart constructor.
jobTransformNameMApping Source #
Creates a value of JobTransformNameMApping
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SourceSpec
data SourceSpec Source #
The source to read from, plus its parameters.
See: sourceSpec
smart constructor.
Creates a value of SourceSpec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssAddtional :: Lens' SourceSpec (HashMap Text JSONValue) Source #
Properties of the object.
SourceMetadata
data SourceMetadata Source #
Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.
See: sourceMetadata
smart constructor.
sourceMetadata :: SourceMetadata Source #
Creates a value of SourceMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smEstimatedSizeBytes :: Lens' SourceMetadata (Maybe Int64) Source #
An estimate of the total size (in bytes) of the data that would be read from this source. This estimate is in terms of external storage size, before any decompression or other processing done by the reader.
smProducesSortedKeys :: Lens' SourceMetadata (Maybe Bool) Source #
Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.
smInfinite :: Lens' SourceMetadata (Maybe Bool) Source #
Specifies that the size of this source is known to be infinite (this is a streaming source).
EnvironmentInternalExperiments
data EnvironmentInternalExperiments Source #
Experimental settings.
See: environmentInternalExperiments
smart constructor.
environmentInternalExperiments Source #
Creates a value of EnvironmentInternalExperiments
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eieAddtional :: Lens' EnvironmentInternalExperiments (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
TaskRunnerSettings
data TaskRunnerSettings Source #
Taskrunner configuration settings.
See: taskRunnerSettings
smart constructor.
taskRunnerSettings :: TaskRunnerSettings Source #
Creates a value of TaskRunnerSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
trsContinueOnException
trsHarnessCommand
trsWorkflowFileName
trsTaskGroup
trsAlsologtostderr
trsDataflowAPIVersion
trsLogDir
trsCommandlinesFileName
trsVMId
trsBaseURL
trsOAuthScopes
trsTaskUser
trsStreamingWorkerMainClass
trsBaseTaskDir
trsLogUploadLocation
trsTempStoragePrefix
trsLogToSerialconsole
trsParallelWorkerSettings
trsLanguageHint
trsContinueOnException :: Lens' TaskRunnerSettings (Maybe Bool) Source #
Do we continue taskrunner if an exception is hit?
trsHarnessCommand :: Lens' TaskRunnerSettings (Maybe Text) Source #
Command to launch the worker harness.
trsWorkflowFileName :: Lens' TaskRunnerSettings (Maybe Text) Source #
Store the workflow in this file.
trsTaskGroup :: Lens' TaskRunnerSettings (Maybe Text) Source #
The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".
trsAlsologtostderr :: Lens' TaskRunnerSettings (Maybe Bool) Source #
Also send taskrunner log info to stderr?
trsDataflowAPIVersion :: Lens' TaskRunnerSettings (Maybe Text) Source #
API version of endpoint, e.g. "v1b3"
trsCommandlinesFileName :: Lens' TaskRunnerSettings (Maybe Text) Source #
Store preprocessing commands in this file.
trsBaseURL :: Lens' TaskRunnerSettings (Maybe Text) Source #
The base URL for the taskrunner to use when accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
trsOAuthScopes :: Lens' TaskRunnerSettings [Text] Source #
OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.
trsTaskUser :: Lens' TaskRunnerSettings (Maybe Text) Source #
The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".
trsStreamingWorkerMainClass :: Lens' TaskRunnerSettings (Maybe Text) Source #
Streaming worker main class name.
trsBaseTaskDir :: Lens' TaskRunnerSettings (Maybe Text) Source #
Location on the worker for task-specific subdirectories.
trsLogUploadLocation :: Lens' TaskRunnerSettings (Maybe Text) Source #
Indicates where to put logs. If this is not specified, the logs will not be uploaded. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
trsTempStoragePrefix :: Lens' TaskRunnerSettings (Maybe Text) Source #
The prefix of the resources the taskrunner should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
trsLogToSerialconsole :: Lens' TaskRunnerSettings (Maybe Bool) Source #
Send taskrunner log into to Google Compute Engine VM serial console?
trsParallelWorkerSettings :: Lens' TaskRunnerSettings (Maybe WorkerSettings) Source #
Settings to pass to the parallel worker harness.
trsLanguageHint :: Lens' TaskRunnerSettings (Maybe Text) Source #
Suggested backend language.
EnvironmentSdkPipelineOptions
data EnvironmentSdkPipelineOptions Source #
The Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way.
See: environmentSdkPipelineOptions
smart constructor.
environmentSdkPipelineOptions Source #
Creates a value of EnvironmentSdkPipelineOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
espoAddtional :: Lens' EnvironmentSdkPipelineOptions (HashMap Text JSONValue) Source #
Properties of the object.
LeaseWorkItemRequest
data LeaseWorkItemRequest Source #
Request to lease WorkItems.
See: leaseWorkItemRequest
smart constructor.
leaseWorkItemRequest :: LeaseWorkItemRequest Source #
Creates a value of LeaseWorkItemRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lwirWorkItemTypes :: Lens' LeaseWorkItemRequest [Text] Source #
Filter for WorkItem type.
lwirCurrentWorkerTime :: Lens' LeaseWorkItemRequest (Maybe Text) Source #
The current timestamp at the worker.
lwirWorkerCapabilities :: Lens' LeaseWorkItemRequest [Text] Source #
Worker capabilities. WorkItems might be limited to workers with specific capabilities.
lwirRequestedLeaseDuration :: Lens' LeaseWorkItemRequest (Maybe Text) Source #
The initial lease period.
lwirWorkerId :: Lens' LeaseWorkItemRequest (Maybe Text) Source #
Identifies the worker leasing work -- typically the ID of the virtual machine running the worker.
SourceOperationResponse
data SourceOperationResponse Source #
The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.
See: sourceOperationResponse
smart constructor.
sourceOperationResponse :: SourceOperationResponse Source #
Creates a value of SourceOperationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sorSplit :: Lens' SourceOperationResponse (Maybe SourceSplitResponse) Source #
A response to a request to split a source.
sorGetMetadata :: Lens' SourceOperationResponse (Maybe SourceGetMetadataResponse) Source #
A response to a request to get metadata about a source.
TopologyConfigUserStageToComputationNameMap
data TopologyConfigUserStageToComputationNameMap Source #
Maps user stage names to stable computation names.
See: topologyConfigUserStageToComputationNameMap
smart constructor.
topologyConfigUserStageToComputationNameMap Source #
Creates a value of TopologyConfigUserStageToComputationNameMap
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ShellTask
A task which consists of a shell command for the worker to execute.
See: shellTask
smart constructor.
shellTask :: ShellTask Source #
Creates a value of ShellTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
StatusDetailsItem
data StatusDetailsItem Source #
Creates a value of StatusDetailsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
ReportedParallelism
data ReportedParallelism Source #
Represents the level of parallelism in a WorkItem's input, reported by the worker.
See: reportedParallelism
smart constructor.
reportedParallelism :: ReportedParallelism Source #
Creates a value of ReportedParallelism
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rpValue :: Lens' ReportedParallelism (Maybe Double) Source #
Specifies the level of parallelism in case it is finite.
rpIsInfinite :: Lens' ReportedParallelism (Maybe Bool) Source #
Specifies whether the parallelism is infinite. If true, "value" is ignored. Infinite parallelism means the service will assume that the work item can always be split into more non-empty work items by dynamic splitting. This is a work-around for lack of support for infinity by the current JSON-based Java RPC stack.
StepProperties
data StepProperties Source #
Named properties associated with the step. Each kind of predefined step has its own required set of properties.
See: stepProperties
smart constructor.
Creates a value of StepProperties
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
spAddtional :: Lens' StepProperties (HashMap Text JSONValue) Source #
Properties of the object.
TopologyConfig
data TopologyConfig Source #
Global topology of the streaming Dataflow job, including all computations and their sharded locations.
See: topologyConfig
smart constructor.
topologyConfig :: TopologyConfig Source #
Creates a value of TopologyConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tcDataDiskAssignments :: Lens' TopologyConfig [DataDiskAssignment] Source #
The disks assigned to a streaming Dataflow job.
tcPersistentStateVersion :: Lens' TopologyConfig (Maybe Int32) Source #
Version number for persistent state.
tcForwardingKeyBits :: Lens' TopologyConfig (Maybe Int32) Source #
The size (in bits) of keys that will be assigned to source messages.
tcUserStageToComputationNameMap :: Lens' TopologyConfig (Maybe TopologyConfigUserStageToComputationNameMap) Source #
Maps user stage names to stable computation names.
tcComputations :: Lens' TopologyConfig [ComputationTopology] Source #
The computations associated with a streaming Dataflow job.
ApproximateSplitRequest
data ApproximateSplitRequest Source #
A suggestion by the service to the worker to dynamically split the WorkItem.
See: approximateSplitRequest
smart constructor.
approximateSplitRequest :: ApproximateSplitRequest Source #
Creates a value of ApproximateSplitRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
asrFractionConsumed :: Lens' ApproximateSplitRequest (Maybe Double) Source #
A fraction at which to split the work item, from 0.0 (beginning of the input) to 1.0 (end of the input).
asrPosition :: Lens' ApproximateSplitRequest (Maybe Position) Source #
A Position at which to split the work item.
WorkerSettings
data WorkerSettings Source #
Provides data to pass through to the worker harness.
See: workerSettings
smart constructor.
workerSettings :: WorkerSettings Source #
Creates a value of WorkerSettings
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wsServicePath :: Lens' WorkerSettings (Maybe Text) Source #
The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".
wsBaseURL :: Lens' WorkerSettings (Maybe Text) Source #
The base URL for accessing Google Cloud APIs. When workers access Google Cloud APIs, they logically do so via relative URLs. If this field is specified, it supplies the base URL to use for resolving these relative URLs. The normative algorithm used is defined by RFC 1808, "Relative Uniform Resource Locators". If not specified, the default value is "http://www.googleapis.com/"
wsShuffleServicePath :: Lens' WorkerSettings (Maybe Text) Source #
The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".
wsTempStoragePrefix :: Lens' WorkerSettings (Maybe Text) Source #
The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
wsReportingEnabled :: Lens' WorkerSettings (Maybe Bool) Source #
Send work progress updates to service.
wsWorkerId :: Lens' WorkerSettings (Maybe Text) Source #
ID of the worker running this pipeline.
WorkItemServiceStateHarnessData
data WorkItemServiceStateHarnessData Source #
Other data returned by the service, specific to the particular worker harness.
See: workItemServiceStateHarnessData
smart constructor.
workItemServiceStateHarnessData Source #
Creates a value of WorkItemServiceStateHarnessData
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wisshdAddtional :: Lens' WorkItemServiceStateHarnessData (HashMap Text JSONValue) Source #
Properties of the object.
DataDiskAssignment
data DataDiskAssignment Source #
Data disk assignment for a given VM instance.
See: dataDiskAssignment
smart constructor.
dataDiskAssignment :: DataDiskAssignment Source #
Creates a value of DataDiskAssignment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ddaVMInstance :: Lens' DataDiskAssignment (Maybe Text) Source #
VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0".
ddaDataDisks :: Lens' DataDiskAssignment [Text] Source #
Mounted data disks. The order is important a data disk's 0-based index in this list defines which persistent directory the disk is mounted to, for example the list of { "myproject-1014-104817-4c2-harness-0-disk-0" }, { "myproject-1014-104817-4c2-harness-0-disk-1" }.
WorkerMessageResponse
data WorkerMessageResponse Source #
A worker_message response allows the server to pass information to the sender.
See: workerMessageResponse
smart constructor.
workerMessageResponse :: WorkerMessageResponse Source #
Creates a value of WorkerMessageResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wmrWorkerHealthReportResponse :: Lens' WorkerMessageResponse (Maybe WorkerHealthReportResponse) Source #
The service's response to a worker's health report.
WorkItemServiceState
data WorkItemServiceState Source #
The Dataflow service's idea of the current state of a WorkItem being processed by a worker.
See: workItemServiceState
smart constructor.
workItemServiceState :: WorkItemServiceState Source #
Creates a value of WorkItemServiceState
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wissNextReportIndex :: Lens' WorkItemServiceState (Maybe Int64) Source #
The index value to use for the next report sent by the worker. Note: If the report call fails for whatever reason, the worker should reuse this index for subsequent report attempts.
wissReportStatusInterval :: Lens' WorkItemServiceState (Maybe Text) Source #
New recommended reporting interval.
wissHarnessData :: Lens' WorkItemServiceState (Maybe WorkItemServiceStateHarnessData) Source #
Other data returned by the service, specific to the particular worker harness.
wissSuggestedStopPoint :: Lens' WorkItemServiceState (Maybe ApproximateProgress) Source #
DEPRECATED in favor of split_request.
wissSuggestedStopPosition :: Lens' WorkItemServiceState (Maybe Position) Source #
Obsolete, always empty.
wissLeaseExpireTime :: Lens' WorkItemServiceState (Maybe Text) Source #
Time at which the current lease will expire.
wissSplitRequest :: Lens' WorkItemServiceState (Maybe ApproximateSplitRequest) Source #
The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.
StreamingSetupTask
data StreamingSetupTask Source #
A task which initializes part of a streaming Dataflow job.
See: streamingSetupTask
smart constructor.
streamingSetupTask :: StreamingSetupTask Source #
Creates a value of StreamingSetupTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sstStreamingComputationTopology :: Lens' StreamingSetupTask (Maybe TopologyConfig) Source #
The global topology of the streaming Dataflow job.
sstReceiveWorkPort :: Lens' StreamingSetupTask (Maybe Int32) Source #
The TCP port on which the worker should listen for messages from other streaming computation workers.
sstWorkerHarnessPort :: Lens' StreamingSetupTask (Maybe Int32) Source #
The TCP port used by the worker to communicate with the Dataflow worker harness.
PartialGroupByKeyInstructionInputElementCodec
data PartialGroupByKeyInstructionInputElementCodec Source #
The codec to use for interpreting an element in the input PTable.
See: partialGroupByKeyInstructionInputElementCodec
smart constructor.
partialGroupByKeyInstructionInputElementCodec Source #
Creates a value of PartialGroupByKeyInstructionInputElementCodec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pgbkiiecAddtional :: Lens' PartialGroupByKeyInstructionInputElementCodec (HashMap Text JSONValue) Source #
Properties of the object.
MapTask
MapTask consists of an ordered set of instructions, each of which describes one particular low-level operation for the worker to perform in order to accomplish the MapTask's WorkItem. Each instruction must appear in the list before any instructions which depends on its output.
See: mapTask
smart constructor.
Creates a value of MapTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mtInstructions :: Lens' MapTask [ParallelInstruction] Source #
The instructions in the MapTask.
mtSystemName :: Lens' MapTask (Maybe Text) Source #
System-defined name of this MapTask. Unique across the workflow.
mtStageName :: Lens' MapTask (Maybe Text) Source #
System-defined name of the stage containing this MapTask. Unique across the workflow.
MountedDataDisk
data MountedDataDisk Source #
Describes mounted data disk.
See: mountedDataDisk
smart constructor.
mountedDataDisk :: MountedDataDisk Source #
Creates a value of MountedDataDisk
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mddDataDisk :: Lens' MountedDataDisk (Maybe Text) Source #
The name of the data disk. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
SinkCodec
The codec to use to encode data written to the sink.
See: sinkCodec
smart constructor.
Creates a value of SinkCodec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
WorkerHealthReportPodsItem
workerHealthReportPodsItem Source #
Creates a value of WorkerHealthReportPodsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
whrpiAddtional :: Lens' WorkerHealthReportPodsItem (HashMap Text JSONValue) Source #
Properties of the object.
ParDoInstructionUserFn
data ParDoInstructionUserFn Source #
The user function to invoke.
See: parDoInstructionUserFn
smart constructor.
parDoInstructionUserFn Source #
Creates a value of ParDoInstructionUserFn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdiufAddtional :: Lens' ParDoInstructionUserFn (HashMap Text JSONValue) Source #
Properties of the object.
InstructionOutputCodec
data InstructionOutputCodec Source #
The codec to use to encode data being written via this output.
See: instructionOutputCodec
smart constructor.
instructionOutputCodec Source #
Creates a value of InstructionOutputCodec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iocAddtional :: Lens' InstructionOutputCodec (HashMap Text JSONValue) Source #
Properties of the object.
StreamLocation
data StreamLocation Source #
Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.
See: streamLocation
smart constructor.
streamLocation :: StreamLocation Source #
Creates a value of StreamLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
slStreamingStageLocation :: Lens' StreamLocation (Maybe StreamingStageLocation) Source #
The stream is part of another computation within the current streaming Dataflow job.
slSideInputLocation :: Lens' StreamLocation (Maybe StreamingSideInputLocation) Source #
The stream is a streaming side input.
slCustomSourceLocation :: Lens' StreamLocation (Maybe CustomSourceLocation) Source #
The stream is a custom source.
slPubsubLocation :: Lens' StreamLocation (Maybe PubsubLocation) Source #
The stream is a pubsub stream.
WorkerPoolPoolArgs
data WorkerPoolPoolArgs Source #
Extra arguments for this worker pool.
See: workerPoolPoolArgs
smart constructor.
Creates a value of WorkerPoolPoolArgs
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wppaAddtional :: Lens' WorkerPoolPoolArgs (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'ype with type URL.
SendWorkerMessagesResponse
data SendWorkerMessagesResponse Source #
The response to the worker messages.
See: sendWorkerMessagesResponse
smart constructor.
sendWorkerMessagesResponse :: SendWorkerMessagesResponse Source #
Creates a value of SendWorkerMessagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
swmrWorkerMessageResponses :: Lens' SendWorkerMessagesResponse [WorkerMessageResponse] Source #
The servers response to the worker messages.
StreamingSideInputLocation
data StreamingSideInputLocation Source #
Identifies the location of a streaming side input.
See: streamingSideInputLocation
smart constructor.
streamingSideInputLocation :: StreamingSideInputLocation Source #
Creates a value of StreamingSideInputLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssilTag :: Lens' StreamingSideInputLocation (Maybe Text) Source #
Identifies the particular side input within the streaming Dataflow job.
ssilStateFamily :: Lens' StreamingSideInputLocation (Maybe Text) Source #
Identifies the state family where this side input is stored.
StreamingComputationTask
data StreamingComputationTask Source #
A task which describes what action should be performed for the specified streaming computation ranges.
See: streamingComputationTask
smart constructor.
streamingComputationTask :: StreamingComputationTask Source #
Creates a value of StreamingComputationTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sctTaskType :: Lens' StreamingComputationTask (Maybe Text) Source #
A type of streaming computation task.
sctDataDisks :: Lens' StreamingComputationTask [MountedDataDisk] Source #
Describes the set of data disks this task should apply to.
sctComputationRanges :: Lens' StreamingComputationTask [StreamingComputationRanges] Source #
Contains ranges of a streaming computation this task should apply to.
JobMessage
data JobMessage Source #
A particular message pertaining to a Dataflow job.
See: jobMessage
smart constructor.
jobMessage :: JobMessage Source #
Creates a value of JobMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jmMessageText :: Lens' JobMessage (Maybe Text) Source #
The text of the message.
jmMessageImportance :: Lens' JobMessage (Maybe Text) Source #
Importance level of the message.
jmId :: Lens' JobMessage (Maybe Text) Source #
Identifies the message. This is automatically generated by the service; the caller should treat it as an opaque string.
SeqMapTaskOutputInfo
data SeqMapTaskOutputInfo Source #
Information about an output of a SeqMapTask.
See: seqMapTaskOutputInfo
smart constructor.
seqMapTaskOutputInfo :: SeqMapTaskOutputInfo Source #
Creates a value of SeqMapTaskOutputInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smtoiTag :: Lens' SeqMapTaskOutputInfo (Maybe Text) Source #
The id of the TupleTag the user code will tag the output value by.
SourceGetMetadataRequest
data SourceGetMetadataRequest Source #
A request to compute the SourceMetadata of a Source.
See: sourceGetMetadataRequest
smart constructor.
sourceGetMetadataRequest :: SourceGetMetadataRequest Source #
Creates a value of SourceGetMetadataRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sgmrSource :: Lens' SourceGetMetadataRequest (Maybe Source) Source #
Specification of the source whose metadata should be computed.
SeqMapTaskUserFn
data SeqMapTaskUserFn Source #
The user function to invoke.
See: seqMapTaskUserFn
smart constructor.
Creates a value of SeqMapTaskUserFn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smtufAddtional :: Lens' SeqMapTaskUserFn (HashMap Text JSONValue) Source #
Properties of the object.
PartialGroupByKeyInstructionValueCombiningFn
data PartialGroupByKeyInstructionValueCombiningFn Source #
The value combining function to invoke.
See: partialGroupByKeyInstructionValueCombiningFn
smart constructor.
partialGroupByKeyInstructionValueCombiningFn Source #
Creates a value of PartialGroupByKeyInstructionValueCombiningFn
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pgbkivcfAddtional :: Lens' PartialGroupByKeyInstructionValueCombiningFn (HashMap Text JSONValue) Source #
Properties of the object.
Job
Defines a job to be run by the Dataflow service.
See: job
smart constructor.
Creates a value of Job
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jRequestedState :: Lens' Job (Maybe Text) Source #
The job's requested state. UpdateJob may be used to switch between the JOB_STATE_STOPPED and JOB_STATE_RUNNING states, by setting requested_state. UpdateJob may also be used to directly set a job's requested state to JOB_STATE_CANCELLED or JOB_STATE_DONE, irrevocably terminating the job if it has not already reached a terminal state.
jEnvironment :: Lens' Job (Maybe Environment) Source #
Environment for the job.
jClientRequestId :: Lens' Job (Maybe Text) Source #
Client's unique identifier of the job, re-used by SDK across retried attempts. If this field is set, the service will ensure its uniqueness. That is, the request to create a job will fail if the service has knowledge of a previously submitted job with the same client's id and job name. The caller may, for example, use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
jCurrentState :: Lens' Job (Maybe Text) Source #
The current state of the job. Jobs are created in the JOB_STATE_STOPPED state unless otherwise specified. A job in the JOB_STATE_RUNNING state may asynchronously enter a terminal state. Once a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Dataflow service; callers cannot mutate it.
jReplacedByJobId :: Lens' Job (Maybe Text) Source #
If another job is an update of this job (and thus, this job is in JOB_STATE_UPDATED), this field will contain the ID of that job.
jTempFiles :: Lens' Job [Text] Source #
A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}
jExecutionInfo :: Lens' Job (Maybe JobExecutionInfo) Source #
Information about how the Dataflow service will actually run the job.
jName :: Lens' Job (Maybe Text) Source #
The user-specified Dataflow job name. Only one Job with a given name may exist in a project at any given time. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt will return the existing Job. The name must match the regular expression a-z?
jTransformNameMApping :: Lens' Job (Maybe JobTransformNameMApping) Source #
Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
jId :: Lens' Job (Maybe Text) Source #
The unique ID of this job. This field is set by the Dataflow service when the Job is created, and is immutable for the life of the Job.
jCurrentStateTime :: Lens' Job (Maybe Text) Source #
The timestamp associated with the current state.
jReplaceJobId :: Lens' Job (Maybe Text) Source #
If this job is an update of an existing job, this field will be the ID of the job it replaced. When sending a CreateJobRequest, you can update a job by specifying it here. The job named here will be stopped, and its intermediate state transferred to this job.
jCreateTime :: Lens' Job (Maybe Text) Source #
Timestamp when job was initially created. Immutable, set by the Dataflow service.
ReadInstruction
data ReadInstruction Source #
An instruction that reads records. Takes no inputs, produces one output.
See: readInstruction
smart constructor.
readInstruction :: ReadInstruction Source #
Creates a value of ReadInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ApproximateReportedProgress
data ApproximateReportedProgress Source #
A progress measurement of a WorkItem by a worker.
See: approximateReportedProgress
smart constructor.
approximateReportedProgress :: ApproximateReportedProgress Source #
Creates a value of ApproximateReportedProgress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
arpFractionConsumed :: Lens' ApproximateReportedProgress (Maybe Double) Source #
Completion as fraction of the input consumed, from 0.0 (beginning, nothing consumed), to 1.0 (end of the input, entire input consumed).
arpConsumedParallelism :: Lens' ApproximateReportedProgress (Maybe ReportedParallelism) Source #
Total amount of parallelism in the portion of input of this work item that has already been consumed. In the first two examples above (see remaining_parallelism), the value should be 30 or 3 respectively. The sum of remaining_parallelism and consumed_parallelism should equal the total amount of parallelism in this work item. If specified, must be finite.
arpRemainingParallelism :: Lens' ApproximateReportedProgress (Maybe ReportedParallelism) Source #
Total amount of parallelism in the input of this WorkItem that has not been consumed yet (i.e. can be delegated to a new WorkItem via dynamic splitting). "Amount of parallelism" refers to how many non-empty parts of the input can be read in parallel. This does not necessarily equal number of records. An input that can be read in parallel down to the individual records is called "perfectly splittable". An example of non-perfectly parallelizable input is a block-compressed file format where a block of records has to be read as a whole, but different blocks can be read in parallel. Examples: * If we have read 30 records out of 50 in a perfectly splittable 50-record input, this value should be 20. * If we are reading through block 3 in a block-compressed file consisting of 5 blocks, this value should be 2 (since blocks 4 and 5 can be processed in parallel by new work items via dynamic splitting). * If we are reading through the last block in a block-compressed file, or reading or processing the last record in a perfectly splittable input, this value should be 0, because the remainder of the work item cannot be further split.
arpPosition :: Lens' ApproximateReportedProgress (Maybe Position) Source #
A Position within the work to represent a progress.
SinkSpec
The sink to write to, plus its parameters.
See: sinkSpec
smart constructor.
Creates a value of SinkSpec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
WorkerPool
data WorkerPool Source #
Describes one particular pool of Dataflow workers to be instantiated by the Dataflow service in order to perform the computations required by a job. Note that a workflow job may use multiple pools, in order to match the various computational requirements of the various stages of the job.
See: workerPool
smart constructor.
workerPool :: WorkerPool Source #
Creates a value of WorkerPool
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wpAutoscalingSettings :: Lens' WorkerPool (Maybe AutoscalingSettings) Source #
Settings for autoscaling of this WorkerPool.
wpNumThreadsPerWorker :: Lens' WorkerPool (Maybe Int32) Source #
The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).
wpDiskSizeGb :: Lens' WorkerPool (Maybe Int32) Source #
Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.
wpKind :: Lens' WorkerPool (Maybe Text) Source #
The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.
wpTaskrunnerSettings :: Lens' WorkerPool (Maybe TaskRunnerSettings) Source #
Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.
wpNumWorkers :: Lens' WorkerPool (Maybe Int32) Source #
Number of Google Compute Engine workers in this pool needed to execute the job. If zero or unspecified, the service will attempt to choose a reasonable default.
wpNetwork :: Lens' WorkerPool (Maybe Text) Source #
Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".
wpZone :: Lens' WorkerPool (Maybe Text) Source #
Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.
wpPackages :: Lens' WorkerPool [Package] Source #
Packages to be installed on workers.
wpOnHostMaintenance :: Lens' WorkerPool (Maybe Text) Source #
The action to take on host maintenance, as defined by the Google Compute Engine API.
wpDiskSourceImage :: Lens' WorkerPool (Maybe Text) Source #
Fully qualified source image for disks.
wpSubnetwork :: Lens' WorkerPool (Maybe Text) Source #
Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "zones/ZONE/subnetworks/SUBNETWORK".
wpMachineType :: Lens' WorkerPool (Maybe Text) Source #
Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.
wpMetadata :: Lens' WorkerPool (Maybe WorkerPoolMetadata) Source #
Metadata to set on the Google Compute Engine VMs.
wpDiskType :: Lens' WorkerPool (Maybe Text) Source #
Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.
wpTeardownPolicy :: Lens' WorkerPool (Maybe Text) Source #
Sets the policy for determining when to turndown worker pool. Allowed values are: TEARDOWN_ALWAYS, TEARDOWN_ON_SUCCESS, and TEARDOWN_NEVER. TEARDOWN_ALWAYS means workers are always torn down regardless of whether the job succeeds. TEARDOWN_ON_SUCCESS means workers are torn down if the job succeeds. TEARDOWN_NEVER means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the TEARDOWN_ALWAYS policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default.
wpDefaultPackageSet :: Lens' WorkerPool (Maybe Text) Source #
The default package set to install. This allows the service to select a default set of packages which are useful to worker harnesses written in a particular language.
wpPoolArgs :: Lens' WorkerPool (Maybe WorkerPoolPoolArgs) Source #
Extra arguments for this worker pool.
wpWorkerHarnessContainerImage :: Lens' WorkerPool (Maybe Text) Source #
Docker container image that executes Dataflow worker harness, residing in Google Container Registry. Required.
wpDataDisks :: Lens' WorkerPool [Disk] Source #
Data disks that are used by a VM in this workflow.
Step
Defines a particular step within a Dataflow job. A job consists of multiple steps, each of which performs some specific operation as part of the overall job. Data is typically passed from one step to another as part of the job. Here's an example of a sequence of steps which together implement a Map-Reduce job: * Read a collection of data from some source, parsing the collection's elements. * Validate the elements. * Apply a user-defined function to map each element to some value and extract an element-specific key value. * Group elements with the same key into a single element with that key, transforming a multiply-keyed collection into a uniquely-keyed collection. * Write the elements out to some data sink. (Note that the Dataflow service may be used to run many different types of jobs, not just Map-Reduce).
See: step
smart constructor.
Creates a value of Step
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sName :: Lens' Step (Maybe Text) Source #
Name identifying the step. This must be unique for each step with respect to all other steps in the dataflow Job.
sProperties :: Lens' Step (Maybe StepProperties) Source #
Named properties associated with the step. Each kind of predefined step has its own required set of properties.
Package
Packages that need to be installed in order for a worker to run the steps of the Dataflow job which will be assigned to its worker pool. This is the mechanism by which the SDK causes code to be loaded onto the workers. For example, the Dataflow Java SDK might use this to install jars containing the user's code and all of the various dependencies (libraries, data files, etc) required in order for that code to run.
See: package
smart constructor.
pLocation :: Lens' Package (Maybe Text) Source #
The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/
WorkerMessageCodeParameters
data WorkerMessageCodeParameters Source #
Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the GCS objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages.
See: workerMessageCodeParameters
smart constructor.
workerMessageCodeParameters Source #
Creates a value of WorkerMessageCodeParameters
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wmcpAddtional :: Lens' WorkerMessageCodeParameters (HashMap Text JSONValue) Source #
Properties of the object.
DynamicSourceSplit
data DynamicSourceSplit Source #
When a task splits using WorkItemStatus.dynamic_source_split, this message describes the two parts of the split relative to the description of the current task's input.
See: dynamicSourceSplit
smart constructor.
dynamicSourceSplit :: DynamicSourceSplit Source #
Creates a value of DynamicSourceSplit
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dssResidual :: Lens' DynamicSourceSplit (Maybe DerivedSource) Source #
Residual part (returned to the pool of work). Specified relative to the previously-current source.
dssPrimary :: Lens' DynamicSourceSplit (Maybe DerivedSource) Source #
Primary part (continued to be processed by worker). Specified relative to the previously-current source. Becomes current.
ReportWorkItemStatusResponse
data ReportWorkItemStatusResponse Source #
Response from a request to report the status of WorkItems.
See: reportWorkItemStatusResponse
smart constructor.
reportWorkItemStatusResponse :: ReportWorkItemStatusResponse Source #
Creates a value of ReportWorkItemStatusResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rwisrWorkItemServiceStates :: Lens' ReportWorkItemStatusResponse [WorkItemServiceState] Source #
A set of messages indicating the service-side state for each WorkItem whose status was reported, in the same order as the WorkItemStatus messages in the ReportWorkItemStatusRequest which resulting in this response.
SourceFork
data SourceFork Source #
DEPRECATED in favor of DynamicSourceSplit.
See: sourceFork
smart constructor.
sourceFork :: SourceFork Source #
Creates a value of SourceFork
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfResidual :: Lens' SourceFork (Maybe SourceSplitShard) Source #
DEPRECATED
sfPrimarySource :: Lens' SourceFork (Maybe DerivedSource) Source #
DEPRECATED
sfPrimary :: Lens' SourceFork (Maybe SourceSplitShard) Source #
DEPRECATED
sfResidualSource :: Lens' SourceFork (Maybe DerivedSource) Source #
DEPRECATED
StreamingComputationRanges
data StreamingComputationRanges Source #
Describes full or partial data disk assignment information of the computation ranges.
See: streamingComputationRanges
smart constructor.
streamingComputationRanges :: StreamingComputationRanges Source #
Creates a value of StreamingComputationRanges
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scrRangeAssignments :: Lens' StreamingComputationRanges [KeyRangeDataDiskAssignment] Source #
Data disk assignments for ranges from this computation.
scrComputationId :: Lens' StreamingComputationRanges (Maybe Text) Source #
The ID of the computation.
ListJobsResponse
data ListJobsResponse Source #
Response to a request to list Dataflow jobs. This may be a partial response, depending on the page size in the ListJobsRequest.
See: listJobsResponse
smart constructor.
listJobsResponse :: ListJobsResponse Source #
Creates a value of ListJobsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text) Source #
Set if there may be more results than fit in this response.
Source
A source that records can be read and decoded from.
See: source
smart constructor.
Creates a value of Source
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
souDoesNotNeedSplitting :: Lens' Source (Maybe Bool) Source #
Setting this value to true hints to the framework that the source doesn't need splitting, and using SourceSplitRequest on it would yield SOURCE_SPLIT_OUTCOME_USE_CURRENT. E.g. a file splitter may set this to true when splitting a single file into a set of byte ranges of appropriate size, and set this to false when splitting a filepattern into individual files. However, for efficiency, a file splitter may decide to produce file subranges directly from the filepattern to avoid a splitting round-trip. See SourceSplitRequest for an overview of the splitting process. This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
souBaseSpecs :: Lens' Source [SourceBaseSpecsItem] Source #
While splitting, sources may specify the produced bundles as differences against another source, in order to save backend-side memory and allow bigger jobs. For details, see SourceSplitRequest. To support this use case, the full set of parameters of the source is logically obtained by taking the latest explicitly specified value of each parameter in the order: base_specs (later items win), spec (overrides anything in base_specs).
souCodec :: Lens' Source (Maybe SourceCodec) Source #
The codec to use to decode data read from the source.
souMetadata :: Lens' Source (Maybe SourceMetadata) Source #
Optionally, metadata for this source can be supplied right away, avoiding a SourceGetMetadataOperation roundtrip (see SourceOperationRequest). This field is meaningful only in the Source objects populated by the user (e.g. when filling in a DerivedSource). Source objects supplied by the framework to the user don't have this field populated.
ApproximateProgress
data ApproximateProgress Source #
Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.
See: approximateProgress
smart constructor.
approximateProgress :: ApproximateProgress Source #
Creates a value of ApproximateProgress
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
apRemainingTime :: Lens' ApproximateProgress (Maybe Text) Source #
Obsolete.
apPercentComplete :: Lens' ApproximateProgress (Maybe Double) Source #
Obsolete.
apPosition :: Lens' ApproximateProgress (Maybe Position) Source #
Obsolete.
WorkerMessage
data WorkerMessage Source #
WorkerMessage provides information to the backend about a worker.
See: workerMessage
smart constructor.
workerMessage :: WorkerMessage Source #
Creates a value of WorkerMessage
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wmWorkerHealthReport :: Lens' WorkerMessage (Maybe WorkerHealthReport) Source #
The health of a worker.
wmWorkerMessageCode :: Lens' WorkerMessage (Maybe WorkerMessageCode) Source #
A worker message code.
wmLabels :: Lens' WorkerMessage (Maybe WorkerMessageLabels) Source #
Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here.
KeyRangeLocation
data KeyRangeLocation Source #
Location information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
See: keyRangeLocation
smart constructor.
keyRangeLocation :: KeyRangeLocation Source #
Creates a value of KeyRangeLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
krlPersistentDirectory :: Lens' KeyRangeLocation (Maybe Text) Source #
The location of the persistent state for this range, as a persistent directory in the worker local filesystem.
krlDataDisk :: Lens' KeyRangeLocation (Maybe Text) Source #
The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
krlDeliveryEndpoint :: Lens' KeyRangeLocation (Maybe Text) Source #
The physical location of this range assignment to be used for streaming computation cross-worker message delivery.
MultiOutputInfo
data MultiOutputInfo Source #
Information about an output of a multi-output DoFn.
See: multiOutputInfo
smart constructor.
multiOutputInfo :: MultiOutputInfo Source #
Creates a value of MultiOutputInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
moiTag :: Lens' MultiOutputInfo (Maybe Text) Source #
The id of the tag the user code will emit to this output by; this should correspond to the tag of some SideInputInfo.
PartialGroupByKeyInstruction
data PartialGroupByKeyInstruction Source #
An instruction that does a partial group-by-key. One input and one output.
See: partialGroupByKeyInstruction
smart constructor.
partialGroupByKeyInstruction :: PartialGroupByKeyInstruction Source #
Creates a value of PartialGroupByKeyInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pgbkiValueCombiningFn :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionValueCombiningFn) Source #
The value combining function to invoke.
pgbkiSideInputs :: Lens' PartialGroupByKeyInstruction [SideInputInfo] Source #
Zero or more side inputs.
pgbkiInput :: Lens' PartialGroupByKeyInstruction (Maybe InstructionInput) Source #
Describes the input to the partial group-by-key instruction.
pgbkiInputElementCodec :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionInputElementCodec) Source #
The codec to use for interpreting an element in the input PTable.
ParDoInstruction
data ParDoInstruction Source #
An instruction that does a ParDo operation. Takes one main input and zero or more side inputs, and produces zero or more outputs. Runs user code.
See: parDoInstruction
smart constructor.
parDoInstruction :: ParDoInstruction Source #
Creates a value of ParDoInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pdiNumOutputs :: Lens' ParDoInstruction (Maybe Int32) Source #
The number of outputs.
pdiMultiOutputInfos :: Lens' ParDoInstruction [MultiOutputInfo] Source #
Information about each of the outputs, if user_fn is a MultiDoFn.
pdiSideInputs :: Lens' ParDoInstruction [SideInputInfo] Source #
Zero or more side inputs.
pdiInput :: Lens' ParDoInstruction (Maybe InstructionInput) Source #
The input.
pdiUserFn :: Lens' ParDoInstruction (Maybe ParDoInstructionUserFn) Source #
The user function to invoke.
CustomSourceLocation
data CustomSourceLocation Source #
Identifies the location of a custom souce.
See: customSourceLocation
smart constructor.
customSourceLocation :: CustomSourceLocation Source #
Creates a value of CustomSourceLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cslStateful :: Lens' CustomSourceLocation (Maybe Bool) Source #
Whether this source is stateful.
SourceBaseSpecsItem
data SourceBaseSpecsItem Source #
Creates a value of SourceBaseSpecsItem
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sbsiAddtional :: Lens' SourceBaseSpecsItem (HashMap Text JSONValue) Source #
Properties of the object.
ParallelInstruction
data ParallelInstruction Source #
Describes a particular operation comprising a MapTask.
See: parallelInstruction
smart constructor.
parallelInstruction :: ParallelInstruction Source #
Creates a value of ParallelInstruction
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
piRead :: Lens' ParallelInstruction (Maybe ReadInstruction) Source #
Additional information for Read instructions.
piWrite :: Lens' ParallelInstruction (Maybe WriteInstruction) Source #
Additional information for Write instructions.
piParDo :: Lens' ParallelInstruction (Maybe ParDoInstruction) Source #
Additional information for ParDo instructions.
piPartialGroupByKey :: Lens' ParallelInstruction (Maybe PartialGroupByKeyInstruction) Source #
Additional information for PartialGroupByKey instructions.
piOutputs :: Lens' ParallelInstruction [InstructionOutput] Source #
Describes the outputs of the instruction.
piSystemName :: Lens' ParallelInstruction (Maybe Text) Source #
System-defined name of this operation. Unique across the workflow.
piFlatten :: Lens' ParallelInstruction (Maybe FlattenInstruction) Source #
Additional information for Flatten instructions.
SideInputInfoKind
data SideInputInfoKind Source #
How to interpret the source element(s) as a side input value.
See: sideInputInfoKind
smart constructor.
Creates a value of SideInputInfoKind
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siikAddtional :: Lens' SideInputInfoKind (HashMap Text JSONValue) Source #
Properties of the object.
SendWorkerMessagesRequest
data SendWorkerMessagesRequest Source #
A request for sending worker messages to the service.
See: sendWorkerMessagesRequest
smart constructor.
sendWorkerMessagesRequest :: SendWorkerMessagesRequest Source #
Creates a value of SendWorkerMessagesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
swmrWorkerMessages :: Lens' SendWorkerMessagesRequest [WorkerMessage] Source #
The WorkerMessages to send.
SourceSplitShard
data SourceSplitShard Source #
DEPRECATED in favor of DerivedSource.
See: sourceSplitShard
smart constructor.
sourceSplitShard :: SourceSplitShard Source #
Creates a value of SourceSplitShard
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sssDerivationMode :: Lens' SourceSplitShard (Maybe Text) Source #
DEPRECATED
SideInputInfo
data SideInputInfo Source #
Information about a side input of a DoFn or an input of a SeqDoFn.
See: sideInputInfo
smart constructor.
sideInputInfo :: SideInputInfo Source #
Creates a value of SideInputInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
siiTag :: Lens' SideInputInfo (Maybe Text) Source #
The id of the tag the user code will access this side input by; this should correspond to the tag of some MultiOutputInfo.
siiKind :: Lens' SideInputInfo (Maybe SideInputInfoKind) Source #
How to interpret the source element(s) as a side input value.
siiSources :: Lens' SideInputInfo [Source] Source #
The source(s) to read element(s) from to get the value of this side input. If more than one source, then the elements are taken from the sources, in the specified order if order matters. At least one source is required.
JobExecutionInfo
data JobExecutionInfo Source #
Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job.
See: jobExecutionInfo
smart constructor.
jobExecutionInfo :: JobExecutionInfo Source #
Creates a value of JobExecutionInfo
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
jeiStages :: Lens' JobExecutionInfo (Maybe JobExecutionInfoStages) Source #
A mapping from each stage to the information about that stage.
SourceCodec
data SourceCodec Source #
The codec to use to decode data read from the source.
See: sourceCodec
smart constructor.
Creates a value of SourceCodec
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
souAddtional :: Lens' SourceCodec (HashMap Text JSONValue) Source #
Properties of the object.
StateFamilyConfig
data StateFamilyConfig Source #
State family configuration.
See: stateFamilyConfig
smart constructor.
stateFamilyConfig :: StateFamilyConfig Source #
Creates a value of StateFamilyConfig
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sfcIsRead :: Lens' StateFamilyConfig (Maybe Bool) Source #
If true, this family corresponds to a read operation.
sfcStateFamily :: Lens' StateFamilyConfig (Maybe Text) Source #
The state family value.
KeyRangeDataDiskAssignment
data KeyRangeDataDiskAssignment Source #
Data disk assignment information for a specific key-range of a sharded computation. Currently we only support UTF-8 character splits to simplify encoding into JSON.
See: keyRangeDataDiskAssignment
smart constructor.
keyRangeDataDiskAssignment :: KeyRangeDataDiskAssignment Source #
Creates a value of KeyRangeDataDiskAssignment
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
krddaDataDisk :: Lens' KeyRangeDataDiskAssignment (Maybe Text) Source #
The name of the data disk where data for this range is stored. This name is local to the Google Cloud Platform project and uniquely identifies the disk within that project, for example "myproject-1014-104817-4c2-harness-0-disk-1".
krddaStart :: Lens' KeyRangeDataDiskAssignment (Maybe Text) Source #
The start (inclusive) of the key range.
krddaEnd :: Lens' KeyRangeDataDiskAssignment (Maybe Text) Source #
The end (exclusive) of the key range.
SourceSplitRequest
data SourceSplitRequest Source #
Represents the operation to split a high-level Source specification into bundles (parts for parallel processing). At a high level, splitting of a source into bundles happens as follows: SourceSplitRequest is applied to the source. If it returns SOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source is used "as is". Otherwise, splitting is applied recursively to each produced DerivedSource. As an optimization, for any Source, if its does_not_need_splitting is true, the framework assumes that splitting this source would return SOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest. This applies both to the initial source being split and to bundles produced from it.
See: sourceSplitRequest
smart constructor.
sourceSplitRequest :: SourceSplitRequest Source #
Creates a value of SourceSplitRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssrSource :: Lens' SourceSplitRequest (Maybe Source) Source #
Specification of the source to be split.
ssrOptions :: Lens' SourceSplitRequest (Maybe SourceSplitOptions) Source #
Hints for tuning the splitting process.
ListJobMessagesResponse
data ListJobMessagesResponse Source #
Response to a request to list job messages.
See: listJobMessagesResponse
smart constructor.
listJobMessagesResponse :: ListJobMessagesResponse Source #
Creates a value of ListJobMessagesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ljmrJobMessages :: Lens' ListJobMessagesResponse [JobMessage] Source #
Messages in ascending timestamp order.
ljmrNextPageToken :: Lens' ListJobMessagesResponse (Maybe Text) Source #
The token to obtain the next page of results if there are more.
PubsubLocation
data PubsubLocation Source #
Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.
See: pubsubLocation
smart constructor.
pubsubLocation :: PubsubLocation Source #
Creates a value of PubsubLocation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
plTrackingSubscription :: Lens' PubsubLocation (Maybe Text) Source #
If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.
plDropLateData :: Lens' PubsubLocation (Maybe Bool) Source #
Indicates whether the pipeline allows late-arriving data.
plTimestampLabel :: Lens' PubsubLocation (Maybe Text) Source #
If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
plIdLabel :: Lens' PubsubLocation (Maybe Text) Source #
If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
plTopic :: Lens' PubsubLocation (Maybe Text) Source #
A pubsub topic, in the form of "pubsub.googleapis.com/topics/ /"
plSubscription :: Lens' PubsubLocation (Maybe Text) Source #
A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/ /"
InstructionInput
data InstructionInput Source #
An input of an instruction, as a reference to an output of a producer instruction.
See: instructionInput
smart constructor.
instructionInput :: InstructionInput Source #
Creates a value of InstructionInput
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iiProducerInstructionIndex :: Lens' InstructionInput (Maybe Int32) Source #
The index (origin zero) of the parallel instruction that produces the output to be consumed by this input. This index is relative to the list of instructions in this input's instruction's containing MapTask.
iiOutputNum :: Lens' InstructionInput (Maybe Int32) Source #
The output index (origin zero) within the producer.
SeqMapTask
data SeqMapTask Source #
Describes a particular function to invoke.
See: seqMapTask
smart constructor.
seqMapTask :: SeqMapTask Source #
Creates a value of SeqMapTask
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
smtInputs :: Lens' SeqMapTask [SideInputInfo] Source #
Information about each of the inputs.
smtOutputInfos :: Lens' SeqMapTask [SeqMapTaskOutputInfo] Source #
Information about each of the outputs.
smtSystemName :: Lens' SeqMapTask (Maybe Text) Source #
System-defined name of the SeqDo operation. Unique across the workflow.
smtStageName :: Lens' SeqMapTask (Maybe Text) Source #
System-defined name of the stage containing the SeqDo operation. Unique across the workflow.
smtUserFn :: Lens' SeqMapTask (Maybe SeqMapTaskUserFn) Source #
The user function to invoke.
SourceOperationRequest
data SourceOperationRequest Source #
A work item that represents the different operations that can be performed on a user-defined Source specification.
See: sourceOperationRequest
smart constructor.
sourceOperationRequest :: SourceOperationRequest Source #
Creates a value of SourceOperationRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sSplit :: Lens' SourceOperationRequest (Maybe SourceSplitRequest) Source #
Information about a request to split a source.
sGetMetadata :: Lens' SourceOperationRequest (Maybe SourceGetMetadataRequest) Source #
Information about a request to get metadata about a source.
LeaseWorkItemResponse
data LeaseWorkItemResponse Source #
Response to a request to lease WorkItems.
See: leaseWorkItemResponse
smart constructor.
leaseWorkItemResponse :: LeaseWorkItemResponse Source #
Creates a value of LeaseWorkItemResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lwirWorkItems :: Lens' LeaseWorkItemResponse [WorkItem] Source #
A list of the leased WorkItems.
Position
Position defines a position within a collection of data. The value can be either the end position, a key (used with ordered collections), a byte offset, or a record index.
See: position
smart constructor.
Creates a value of Position
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pConcatPosition :: Lens' Position (Maybe ConcatPosition) Source #
CloudPosition is a concat position.