Network.Google.Dataflow

Google Dataflow API.

See: Google Dataflow API Reference

Service Configuration

dataflowService :: Service

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.

API Declaration

type DataflowAPI = ProjectsJobsWorkItemsLeaseResource :<|> (ProjectsJobsWorkItemsReportStatusResource :<|> (ProjectsJobsMessagesListResource :<|> (ProjectsJobsListResource :<|> (ProjectsJobsGetResource :<|> (ProjectsJobsCreateResource :<|> (ProjectsJobsUpdateResource :<|> ProjectsJobsGetMetricsResource))))))

Represents the entirety of the methods and resources available for the Google Dataflow API service.

Resources

dataflow.projects.jobs.create

module Network.Google.Resource.Dataflow.Projects.Jobs.Create

dataflow.projects.jobs.get

module Network.Google.Resource.Dataflow.Projects.Jobs.Get

dataflow.projects.jobs.getMetrics

module Network.Google.Resource.Dataflow.Projects.Jobs.GetMetrics

dataflow.projects.jobs.list

module Network.Google.Resource.Dataflow.Projects.Jobs.List

dataflow.projects.jobs.messages.list

module Network.Google.Resource.Dataflow.Projects.Jobs.Messages.List

dataflow.projects.jobs.update

module Network.Google.Resource.Dataflow.Projects.Jobs.Update

dataflow.projects.jobs.workItems.lease

module Network.Google.Resource.Dataflow.Projects.Jobs.WorkItems.Lease

dataflow.projects.jobs.workItems.reportStatus

module Network.Google.Resource.Dataflow.Projects.Jobs.WorkItems.ReportStatus

Types

JobExecutionInfoStages

data JobExecutionInfoStages

A mapping from each stage to the information about that stage.

See: jobExecutionInfoStages smart constructor.

Instances

Eq JobExecutionInfoStages

Data JobExecutionInfoStages

Show JobExecutionInfoStages

Generic JobExecutionInfoStages

ToJSON JobExecutionInfoStages

FromJSON JobExecutionInfoStages

type Rep JobExecutionInfoStages

jobExecutionInfoStages

Arguments

:: HashMap Text JobExecutionStageInfo

jeisAddtional

-> JobExecutionInfoStages

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:

• jeisAddtional

jeisAddtional :: Lens' JobExecutionInfoStages (HashMap Text JobExecutionStageInfo)

ComputationTopology

data ComputationTopology

All configuration data for a particular Computation.

See: computationTopology smart constructor.

Instances

Eq ComputationTopology

Data ComputationTopology

Show ComputationTopology

Generic ComputationTopology

ToJSON ComputationTopology

FromJSON ComputationTopology

type Rep ComputationTopology

computationTopology :: ComputationTopology

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
• ctUserStageName
• ctInputs
• ctKeyRanges
• ctOutputs
• ctComputationId
• ctSystemStageName

ctStateFamilies :: Lens' ComputationTopology [StateFamilyConfig]

The state family values.

ctUserStageName :: Lens' ComputationTopology (Maybe Text)

The user stage name.

ctInputs :: Lens' ComputationTopology [StreamLocation]

The inputs to the computation.

ctKeyRanges :: Lens' ComputationTopology [KeyRangeLocation]

The key ranges processed by the computation.

ctOutputs :: Lens' ComputationTopology [StreamLocation]

The outputs from the computation.

ctComputationId :: Lens' ComputationTopology (Maybe Text)

The ID of the computation.

ctSystemStageName :: Lens' ComputationTopology (Maybe Text)

The system stage name.

SourceSplitResponse

data SourceSplitResponse

The response to a SourceSplitRequest.

See: sourceSplitResponse smart constructor.

Instances

Eq SourceSplitResponse

Data SourceSplitResponse

Show SourceSplitResponse

Generic SourceSplitResponse

ToJSON SourceSplitResponse

FromJSON SourceSplitResponse

type Rep SourceSplitResponse

sourceSplitResponse :: SourceSplitResponse

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
• ssrShards
• ssrOutcome

ssrBundles :: Lens' SourceSplitResponse [DerivedSource]

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]

DEPRECATED in favor of bundles.

ssrOutcome :: Lens' SourceSplitResponse (Maybe Text)

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

data 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.

Instances

Eq Status

Data Status

Show Status

Generic Status

ToJSON Status

FromJSON Status

type Rep Status

status :: Status

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

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

• sDetails
• sCode
• sMessage

sDetails :: Lens' Status [StatusDetailsItem]

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)

The status code, which should be an enum value of [google.rpc.Code][].

sMessage :: Lens' Status (Maybe Text)

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][google.rpc.Status.details] field, or localized by the client.

WorkItem

data WorkItem

WorkItem represents basic information about a WorkItem to be executed in the cloud.

See: workItem smart constructor.

Instances

Eq WorkItem

Data WorkItem

Show WorkItem

Generic WorkItem

ToJSON WorkItem

FromJSON WorkItem

type Rep WorkItem

workItem :: WorkItem

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
• wiReportStatusInterval
• wiShellTask
• wiStreamingSetupTask
• wiInitialReportIndex
• wiMapTask
• wiPackages
• wiStreamingComputationTask
• wiSourceOperationTask
• wiId
• wiProjectId
• wiLeaseExpireTime
• wiConfiguration
• wiSeqMapTask

wiJobId :: Lens' WorkItem (Maybe Text)

Identifies the workflow job this WorkItem belongs to.

wiReportStatusInterval :: Lens' WorkItem (Maybe Text)

Recommended reporting interval.

wiShellTask :: Lens' WorkItem (Maybe ShellTask)

Additional information for ShellTask WorkItems.

wiStreamingSetupTask :: Lens' WorkItem (Maybe StreamingSetupTask)

Additional information for StreamingSetupTask WorkItems.

wiInitialReportIndex :: Lens' WorkItem (Maybe Int64)

The initial index to use when reporting the status of the WorkItem.

wiMapTask :: Lens' WorkItem (Maybe MapTask)

Additional information for MapTask WorkItems.

wiPackages :: Lens' WorkItem [Package]

Any required packages that need to be fetched in order to execute this WorkItem.

wiStreamingComputationTask :: Lens' WorkItem (Maybe StreamingComputationTask)

Additional information for StreamingComputationTask WorkItems.

wiSourceOperationTask :: Lens' WorkItem (Maybe SourceOperationRequest)

Additional information for source operation WorkItems.

wiId :: Lens' WorkItem (Maybe Int64)

Identifies this WorkItem.

wiProjectId :: Lens' WorkItem (Maybe Text)

Identifies the cloud project this WorkItem belongs to.

wiLeaseExpireTime :: Lens' WorkItem (Maybe Text)

Time when the lease on this [Work][] will expire.

wiConfiguration :: Lens' WorkItem (Maybe Text)

Work item-specific configuration as an opaque blob.

wiSeqMapTask :: Lens' WorkItem (Maybe SeqMapTask)

Additional information for SeqMapTask WorkItems.

SourceSplitOptions

data SourceSplitOptions

Hints for splitting a Source into bundles (parts for parallel processing) using SourceSplitRequest.

See: sourceSplitOptions smart constructor.

Instances

Eq SourceSplitOptions

Data SourceSplitOptions

Show SourceSplitOptions

Generic SourceSplitOptions

ToJSON SourceSplitOptions

FromJSON SourceSplitOptions

type Rep SourceSplitOptions

sourceSplitOptions :: SourceSplitOptions

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
• ssoDesiredBundleSizeBytes

ssoDesiredShardSizeBytes :: Lens' SourceSplitOptions (Maybe Int64)

DEPRECATED in favor of desired_bundle_size_bytes.

ssoDesiredBundleSizeBytes :: Lens' SourceSplitOptions (Maybe Int64)

The source should be split into a set of bundles where the estimated size of each is approximately this many bytes.

WorkerPoolMetadata

data WorkerPoolMetadata

Metadata to set on the Google Compute Engine VMs.

See: workerPoolMetadata smart constructor.

Instances

Eq WorkerPoolMetadata

Data WorkerPoolMetadata

Show WorkerPoolMetadata

Generic WorkerPoolMetadata

ToJSON WorkerPoolMetadata

FromJSON WorkerPoolMetadata

type Rep WorkerPoolMetadata

workerPoolMetadata

Arguments

:: HashMap Text Text

wpmAddtional

-> WorkerPoolMetadata

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:

• wpmAddtional

wpmAddtional :: Lens' WorkerPoolMetadata (HashMap Text Text)

AutoscalingSettings

data AutoscalingSettings

Settings for WorkerPool autoscaling.

See: autoscalingSettings smart constructor.

Instances

Eq AutoscalingSettings

Data AutoscalingSettings

Show AutoscalingSettings

Generic AutoscalingSettings

ToJSON AutoscalingSettings

FromJSON AutoscalingSettings

type Rep AutoscalingSettings

autoscalingSettings :: AutoscalingSettings

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
• asAlgorithm

asMaxNumWorkers :: Lens' AutoscalingSettings (Maybe Int32)

The maximum number of workers to cap scaling at.

asAlgorithm :: Lens' AutoscalingSettings (Maybe Text)

The algorithm to use for autoscaling.

JobExecutionStageInfo

data JobExecutionStageInfo

Contains information about how a particular [google.dataflow.v1beta3.Step][google.dataflow.v1beta3.Step] will be executed.

See: jobExecutionStageInfo smart constructor.

Instances

Eq JobExecutionStageInfo

Data JobExecutionStageInfo

Show JobExecutionStageInfo

Generic JobExecutionStageInfo

ToJSON JobExecutionStageInfo

FromJSON JobExecutionStageInfo

type Rep JobExecutionStageInfo

jobExecutionStageInfo :: JobExecutionStageInfo

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

jesiStepName :: Lens' JobExecutionStageInfo [Text]

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

An output of an instruction.

See: instructionOutput smart constructor.

Instances

Eq InstructionOutput

Data InstructionOutput

Show InstructionOutput

Generic InstructionOutput

ToJSON InstructionOutput

FromJSON InstructionOutput

type Rep InstructionOutput

instructionOutput :: InstructionOutput

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
• ioName
• ioSystemName

ioCodec :: Lens' InstructionOutput (Maybe InstructionOutputCodec)

The codec to use to encode data being written via this output.

ioName :: Lens' InstructionOutput (Maybe Text)

The user-provided name of this output.

ioSystemName :: Lens' InstructionOutput (Maybe Text)

System-defined name of this output. Unique across the workflow.

ReportWorkItemStatusRequest

data ReportWorkItemStatusRequest

Request to report the status of WorkItems.

See: reportWorkItemStatusRequest smart constructor.

Instances

Eq ReportWorkItemStatusRequest

Data ReportWorkItemStatusRequest

Show ReportWorkItemStatusRequest

Generic ReportWorkItemStatusRequest

ToJSON ReportWorkItemStatusRequest

FromJSON ReportWorkItemStatusRequest

type Rep ReportWorkItemStatusRequest

reportWorkItemStatusRequest :: ReportWorkItemStatusRequest

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
• rwisrWorkItemStatuses
• rwisrWorkerId

rwisrCurrentWorkerTime :: Lens' ReportWorkItemStatusRequest (Maybe Text)

The current timestamp at the worker.

rwisrWorkItemStatuses :: Lens' ReportWorkItemStatusRequest [WorkItemStatus]

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)

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

A structure describing which components and their versions of the service are required in order to run the job.

See: environmentVersion smart constructor.

Instances

Eq EnvironmentVersion

Data EnvironmentVersion

Show EnvironmentVersion

Generic EnvironmentVersion

ToJSON EnvironmentVersion

FromJSON EnvironmentVersion

type Rep EnvironmentVersion

environmentVersion

Arguments

:: HashMap Text JSONValue

evAddtional

-> EnvironmentVersion

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

evAddtional :: Lens' EnvironmentVersion (HashMap Text JSONValue)

Properties of the object.

Sink

data Sink

A sink that records can be encoded and written to.

See: sink smart constructor.

Instances

Eq Sink

Data Sink

Show Sink

Generic Sink

ToJSON Sink

FromJSON Sink

type Rep Sink

sink :: Sink

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

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

• sCodec
• sSpec

sCodec :: Lens' Sink (Maybe SinkCodec)

The codec to use to encode data written to the sink.

sSpec :: Lens' Sink (Maybe SinkSpec)

The sink to write to, plus its parameters.

MetricStructuredName

data MetricStructuredName

Identifies a metric, by describing the source which generated the metric.

See: metricStructuredName smart constructor.

Instances

Eq MetricStructuredName

Data MetricStructuredName

Show MetricStructuredName

Generic MetricStructuredName

ToJSON MetricStructuredName

FromJSON MetricStructuredName

type Rep MetricStructuredName

metricStructuredName :: MetricStructuredName

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
• msnContext
• msnName

msnOrigin :: Lens' MetricStructuredName (Maybe Text)

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)

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'] = .

msnName :: Lens' MetricStructuredName (Maybe Text)

Worker-defined metric name.

WriteInstruction

data WriteInstruction

An instruction that writes records. Takes one input, produces no outputs.

See: writeInstruction smart constructor.

Instances

Eq WriteInstruction

Data WriteInstruction

Show WriteInstruction

Generic WriteInstruction

ToJSON WriteInstruction

FromJSON WriteInstruction

type Rep WriteInstruction

writeInstruction :: WriteInstruction

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:

• wiSink
• wiInput

wiSink :: Lens' WriteInstruction (Maybe Sink)

The sink to write to.

wiInput :: Lens' WriteInstruction (Maybe InstructionInput)

The input.

EnvironmentUserAgent

data EnvironmentUserAgent

A description of the process that generated the request.

See: environmentUserAgent smart constructor.

Instances

Eq EnvironmentUserAgent

Data EnvironmentUserAgent

Show EnvironmentUserAgent

Generic EnvironmentUserAgent

ToJSON EnvironmentUserAgent

FromJSON EnvironmentUserAgent

type Rep EnvironmentUserAgent

environmentUserAgent

Arguments

:: HashMap Text JSONValue

euaAddtional

-> EnvironmentUserAgent

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

euaAddtional :: Lens' EnvironmentUserAgent (HashMap Text JSONValue)

Properties of the object.

Disk

data Disk

Describes the data disk used by a workflow job.

See: disk smart constructor.

Instances

Eq Disk

Data Disk

Show Disk

Generic Disk

ToJSON Disk

FromJSON Disk

type Rep Disk

disk :: Disk

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
• dDiskType
• dMountPoint

dSizeGb :: Lens' Disk (Maybe Int32)

Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

dDiskType :: Lens' Disk (Maybe Text)

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

dMountPoint :: Lens' Disk (Maybe Text)

Directory in a VM where disk is mounted.

MetricUpdate

data MetricUpdate

Describes the state of a metric.

See: metricUpdate smart constructor.

Instances

Eq MetricUpdate

Data MetricUpdate

Show MetricUpdate

Generic MetricUpdate

ToJSON MetricUpdate

FromJSON MetricUpdate

type Rep MetricUpdate

metricUpdate :: MetricUpdate

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
• muInternal
• muSet
• muCumulative
• muKind
• muUpdateTime
• muMeanCount
• muName
• muScalar

muMeanSum :: Lens' MetricUpdate (Maybe JSONValue)

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)

Worker-computed aggregate value for internal use by the Dataflow service.

muSet :: Lens' MetricUpdate (Maybe JSONValue)

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)

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)

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)

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)

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)

Name of the metric.

muScalar :: Lens' MetricUpdate (Maybe JSONValue)

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

The result of a SourceGetMetadataOperation.

See: sourceGetMetadataResponse smart constructor.

Instances

Eq SourceGetMetadataResponse

Data SourceGetMetadataResponse

Show SourceGetMetadataResponse

Generic SourceGetMetadataResponse

ToJSON SourceGetMetadataResponse

FromJSON SourceGetMetadataResponse

type Rep SourceGetMetadataResponse

sourceGetMetadataResponse :: SourceGetMetadataResponse

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

sgmrMetadata :: Lens' SourceGetMetadataResponse (Maybe SourceMetadata)

The computed metadata.

Environment

data Environment

Describes the environment in which a Dataflow Job runs.

See: environment smart constructor.

Instances

Eq Environment

Data Environment

Show Environment

Generic Environment

ToJSON Environment

FromJSON Environment

type Rep Environment

environment :: Environment

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
• eExperiments
• eWorkerPools
• eClusterManagerAPIService
• eVersion
• eInternalExperiments
• eTempStoragePrefix
• eUserAgent
• eSdkPipelineOptions

eDataSet :: Lens' Environment (Maybe Text)

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]

The list of experiments to enable.

eWorkerPools :: Lens' Environment [WorkerPool]

Worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

eClusterManagerAPIService :: Lens' Environment (Maybe Text)

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)

A structure describing which components and their versions of the service are required in order to run the job.

eInternalExperiments :: Lens' Environment (Maybe EnvironmentInternalExperiments)

Experimental settings.

eTempStoragePrefix :: Lens' Environment (Maybe Text)

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)

A description of the process that generated the request.

eSdkPipelineOptions :: Lens' Environment (Maybe EnvironmentSdkPipelineOptions)

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

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.

Instances

Eq ConcatPosition

Data ConcatPosition

Show ConcatPosition

Generic ConcatPosition

ToJSON ConcatPosition

FromJSON ConcatPosition

type Rep ConcatPosition

concatPosition :: ConcatPosition

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:

• cpIndex
• cpPosition

cpIndex :: Lens' ConcatPosition (Maybe Int32)

Index of the inner source.

cpPosition :: Lens' ConcatPosition (Maybe Position)

Position within the inner source.

MetricStructuredNameContext

data MetricStructuredNameContext

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.

Instances

Eq MetricStructuredNameContext

Data MetricStructuredNameContext

Show MetricStructuredNameContext

Generic MetricStructuredNameContext

ToJSON MetricStructuredNameContext

FromJSON MetricStructuredNameContext

type Rep MetricStructuredNameContext

metricStructuredNameContext

Arguments

:: HashMap Text Text

msncAddtional

-> MetricStructuredNameContext

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:

• msncAddtional

msncAddtional :: Lens' MetricStructuredNameContext (HashMap Text Text)

StreamingStageLocation

data StreamingStageLocation

Identifies the location of a streaming computation stage, for stage-to-stage communication.

See: streamingStageLocation smart constructor.

Instances

Eq StreamingStageLocation

Data StreamingStageLocation

Show StreamingStageLocation

Generic StreamingStageLocation

ToJSON StreamingStageLocation

FromJSON StreamingStageLocation

type Rep StreamingStageLocation

streamingStageLocation :: StreamingStageLocation

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

sslStreamId :: Lens' StreamingStageLocation (Maybe Text)

Identifies the particular stream within the streaming Dataflow job.

DerivedSource

data DerivedSource

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.

Instances

Eq DerivedSource

Data DerivedSource

Show DerivedSource

Generic DerivedSource

ToJSON DerivedSource

FromJSON DerivedSource

type Rep DerivedSource

derivedSource :: DerivedSource

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
• dsSource

dsDerivationMode :: Lens' DerivedSource (Maybe Text)

What source to base the produced source on (if any).

dsSource :: Lens' DerivedSource (Maybe Source)

Specification of the source.

JobMetrics

data JobMetrics

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.

Instances

Eq JobMetrics

Data JobMetrics

Show JobMetrics

Generic JobMetrics

ToJSON JobMetrics

FromJSON JobMetrics

type Rep JobMetrics

jobMetrics :: JobMetrics

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
• jmMetricTime

jmMetrics :: Lens' JobMetrics [MetricUpdate]

All metrics for this job.

jmMetricTime :: Lens' JobMetrics (Maybe Text)

Timestamp as of which metric values are current.

WorkItemStatus

data WorkItemStatus

Conveys a worker's progress through the work described by a WorkItem.

See: workItemStatus smart constructor.

Instances

Eq WorkItemStatus

Data WorkItemStatus

Show WorkItemStatus

Generic WorkItemStatus

ToJSON WorkItemStatus

FromJSON WorkItemStatus

type Rep WorkItemStatus

workItemStatus :: WorkItemStatus

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:

• wisProgress
• wisSourceOperationResponse
• wisStopPosition
• wisDynamicSourceSplit
• wisCompleted
• wisSourceFork
• wisReportIndex
• wisRequestedLeaseDuration
• wisErrors
• wisMetricUpdates
• wisWorkItemId

wisProgress :: Lens' WorkItemStatus (Maybe ApproximateProgress)

The WorkItem's approximate progress.

wisSourceOperationResponse :: Lens' WorkItemStatus (Maybe SourceOperationResponse)

If the work item represented a SourceOperationRequest, and the work is completed, contains the result of the operation.

wisStopPosition :: Lens' WorkItemStatus (Maybe Position)

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)

See documentation of stop_position.

wisCompleted :: Lens' WorkItemStatus (Maybe Bool)

True if the WorkItem was completed (successfully or unsuccessfully).

wisSourceFork :: Lens' WorkItemStatus (Maybe SourceFork)

DEPRECATED in favor of dynamic_source_split.

wisReportIndex :: Lens' WorkItemStatus (Maybe Int64)

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)

Amount of time the worker requests for its lease.

wisErrors :: Lens' WorkItemStatus [Status]

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]

Worker output metrics (counters) for this WorkItem.

wisWorkItemId :: Lens' WorkItemStatus (Maybe Text)

Identifies the WorkItem.

FlattenInstruction

data FlattenInstruction

An instruction that copies its inputs (zero or more) to its (single) output.

See: flattenInstruction smart constructor.

Instances

Eq FlattenInstruction

Data FlattenInstruction

Show FlattenInstruction

Generic FlattenInstruction

ToJSON FlattenInstruction

FromJSON FlattenInstruction

type Rep FlattenInstruction

flattenInstruction :: FlattenInstruction

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

fiInputs :: Lens' FlattenInstruction [InstructionInput]

Describes the inputs to the flatten instruction.

JobTransformNameMApping

data JobTransformNameMApping

Map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

See: jobTransformNameMApping smart constructor.

Instances

Eq JobTransformNameMApping

Data JobTransformNameMApping

Show JobTransformNameMApping

Generic JobTransformNameMApping

ToJSON JobTransformNameMApping

FromJSON JobTransformNameMApping

type Rep JobTransformNameMApping

jobTransformNameMApping

Arguments

:: HashMap Text Text

jtnmaAddtional

-> JobTransformNameMApping

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:

• jtnmaAddtional

jtnmaAddtional :: Lens' JobTransformNameMApping (HashMap Text Text)

SourceSpec

data SourceSpec

The source to read from, plus its parameters.

See: sourceSpec smart constructor.

Instances

Eq SourceSpec

Data SourceSpec

Show SourceSpec

Generic SourceSpec

ToJSON SourceSpec

FromJSON SourceSpec

type Rep SourceSpec

sourceSpec

Arguments

:: HashMap Text JSONValue

ssAddtional

-> SourceSpec

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

ssAddtional :: Lens' SourceSpec (HashMap Text JSONValue)

Properties of the object.

SourceMetadata

data SourceMetadata

Metadata about a Source useful for automatically optimizing and tuning the pipeline, etc.

See: sourceMetadata smart constructor.

Instances

Eq SourceMetadata

Data SourceMetadata

Show SourceMetadata

Generic SourceMetadata

ToJSON SourceMetadata

FromJSON SourceMetadata

type Rep SourceMetadata

sourceMetadata :: SourceMetadata

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
• smProducesSortedKeys
• smInfinite

smEstimatedSizeBytes :: Lens' SourceMetadata (Maybe Int64)

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)

Whether this source is known to produce key/value pairs with the (encoded) keys in lexicographically sorted order.

smInfinite :: Lens' SourceMetadata (Maybe Bool)

Specifies that the size of this source is known to be infinite (this is a streaming source).

EnvironmentInternalExperiments

data EnvironmentInternalExperiments

Experimental settings.

See: environmentInternalExperiments smart constructor.

Instances

Eq EnvironmentInternalExperiments

Data EnvironmentInternalExperiments

Show EnvironmentInternalExperiments

Generic EnvironmentInternalExperiments

ToJSON EnvironmentInternalExperiments

FromJSON EnvironmentInternalExperiments

type Rep EnvironmentInternalExperiments

environmentInternalExperiments

Arguments

:: HashMap Text JSONValue

eieAddtional

-> EnvironmentInternalExperiments

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

eieAddtional :: Lens' EnvironmentInternalExperiments (HashMap Text JSONValue)

Properties of the object. Contains field 'ype with type URL.

TaskRunnerSettings

data TaskRunnerSettings

Taskrunner configuration settings.

See: taskRunnerSettings smart constructor.

Instances

Eq TaskRunnerSettings

Data TaskRunnerSettings

Show TaskRunnerSettings

Generic TaskRunnerSettings

ToJSON TaskRunnerSettings

FromJSON TaskRunnerSettings

type Rep TaskRunnerSettings

taskRunnerSettings :: TaskRunnerSettings

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)

Do we continue taskrunner if an exception is hit?

trsHarnessCommand :: Lens' TaskRunnerSettings (Maybe Text)

Command to launch the worker harness.

trsWorkflowFileName :: Lens' TaskRunnerSettings (Maybe Text)

Store the workflow in this file.

trsTaskGroup :: Lens' TaskRunnerSettings (Maybe Text)

The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

trsAlsologtostderr :: Lens' TaskRunnerSettings (Maybe Bool)

Also send taskrunner log info to stderr?

trsDataflowAPIVersion :: Lens' TaskRunnerSettings (Maybe Text)

API version of endpoint, e.g. "v1b3"

trsLogDir :: Lens' TaskRunnerSettings (Maybe Text)

Directory on the VM to store logs.

trsCommandlinesFileName :: Lens' TaskRunnerSettings (Maybe Text)

Store preprocessing commands in this file.

trsVMId :: Lens' TaskRunnerSettings (Maybe Text)

ID string of VM.

trsBaseURL :: Lens' TaskRunnerSettings (Maybe Text)

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]

OAuth2 scopes to be requested by the taskrunner in order to access the dataflow API.

trsTaskUser :: Lens' TaskRunnerSettings (Maybe Text)

The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

trsStreamingWorkerMainClass :: Lens' TaskRunnerSettings (Maybe Text)

Streaming worker main class name.

trsBaseTaskDir :: Lens' TaskRunnerSettings (Maybe Text)

Location on the worker for task-specific subdirectories.

trsLogUploadLocation :: Lens' TaskRunnerSettings (Maybe Text)

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)

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)

Send taskrunner log into to Google Compute Engine VM serial console?

trsParallelWorkerSettings :: Lens' TaskRunnerSettings (Maybe WorkerSettings)

Settings to pass to the parallel worker harness.

trsLanguageHint :: Lens' TaskRunnerSettings (Maybe Text)

Suggested backend language.

EnvironmentSdkPipelineOptions

data EnvironmentSdkPipelineOptions

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.

Instances

Eq EnvironmentSdkPipelineOptions

Data EnvironmentSdkPipelineOptions

Show EnvironmentSdkPipelineOptions

Generic EnvironmentSdkPipelineOptions

ToJSON EnvironmentSdkPipelineOptions

FromJSON EnvironmentSdkPipelineOptions

type Rep EnvironmentSdkPipelineOptions

environmentSdkPipelineOptions

Arguments

:: HashMap Text JSONValue

espoAddtional

-> EnvironmentSdkPipelineOptions

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

espoAddtional :: Lens' EnvironmentSdkPipelineOptions (HashMap Text JSONValue)

Properties of the object.

LeaseWorkItemRequest

data LeaseWorkItemRequest

Request to lease WorkItems.

See: leaseWorkItemRequest smart constructor.

Instances

Eq LeaseWorkItemRequest

Data LeaseWorkItemRequest

Show LeaseWorkItemRequest

Generic LeaseWorkItemRequest

ToJSON LeaseWorkItemRequest

FromJSON LeaseWorkItemRequest

type Rep LeaseWorkItemRequest

leaseWorkItemRequest :: LeaseWorkItemRequest

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
• lwirCurrentWorkerTime
• lwirWorkerCapabilities
• lwirRequestedLeaseDuration
• lwirWorkerId

lwirWorkItemTypes :: Lens' LeaseWorkItemRequest [Text]

Filter for WorkItem type.

lwirCurrentWorkerTime :: Lens' LeaseWorkItemRequest (Maybe Text)

The current timestamp at the worker.

lwirWorkerCapabilities :: Lens' LeaseWorkItemRequest [Text]

Worker capabilities. WorkItems might be limited to workers with specific capabilities.

lwirRequestedLeaseDuration :: Lens' LeaseWorkItemRequest (Maybe Text)

The initial lease period.

lwirWorkerId :: Lens' LeaseWorkItemRequest (Maybe Text)

Identifies the worker leasing work -- typically the ID of the virtual machine running the worker.

SourceOperationResponse

data SourceOperationResponse

The result of a SourceOperationRequest, specified in ReportWorkItemStatusRequest.source_operation when the work item is completed.

See: sourceOperationResponse smart constructor.

Instances

Eq SourceOperationResponse

Data SourceOperationResponse

Show SourceOperationResponse

Generic SourceOperationResponse

ToJSON SourceOperationResponse

FromJSON SourceOperationResponse

type Rep SourceOperationResponse

sourceOperationResponse :: SourceOperationResponse

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
• sorGetMetadata

sorSplit :: Lens' SourceOperationResponse (Maybe SourceSplitResponse)

A response to a request to split a source.

sorGetMetadata :: Lens' SourceOperationResponse (Maybe SourceGetMetadataResponse)

A response to a request to get metadata about a source.

TopologyConfigUserStageToComputationNameMap

data TopologyConfigUserStageToComputationNameMap

Maps user stage names to stable computation names.

See: topologyConfigUserStageToComputationNameMap smart constructor.

Instances

Eq TopologyConfigUserStageToComputationNameMap

Data TopologyConfigUserStageToComputationNameMap

Show TopologyConfigUserStageToComputationNameMap

Generic TopologyConfigUserStageToComputationNameMap

ToJSON TopologyConfigUserStageToComputationNameMap

FromJSON TopologyConfigUserStageToComputationNameMap

type Rep TopologyConfigUserStageToComputationNameMap

topologyConfigUserStageToComputationNameMap

Arguments

:: HashMap Text Text

tcustcnmAddtional

-> TopologyConfigUserStageToComputationNameMap

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:

• tcustcnmAddtional

tcustcnmAddtional :: Lens' TopologyConfigUserStageToComputationNameMap (HashMap Text Text)

ShellTask

data ShellTask

A task which consists of a shell command for the worker to execute.

See: shellTask smart constructor.

Instances

Eq ShellTask

Data ShellTask

Show ShellTask

Generic ShellTask

ToJSON ShellTask

FromJSON ShellTask

type Rep ShellTask

shellTask :: ShellTask

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:

• stCommand
• stExitCode

stCommand :: Lens' ShellTask (Maybe Text)

The shell command to run.

stExitCode :: Lens' ShellTask (Maybe Int32)

Exit code for the task.

StatusDetailsItem

data StatusDetailsItem

Instances

Eq StatusDetailsItem

Data StatusDetailsItem

Show StatusDetailsItem

Generic StatusDetailsItem

ToJSON StatusDetailsItem

FromJSON StatusDetailsItem

type Rep StatusDetailsItem

statusDetailsItem

Arguments

:: HashMap Text JSONValue

sdiAddtional

-> StatusDetailsItem

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

sdiAddtional :: Lens' StatusDetailsItem (HashMap Text JSONValue)

Properties of the object. Contains field 'ype with type URL.

StepProperties

data StepProperties

Named properties associated with the step. Each kind of predefined step has its own required set of properties.

See: stepProperties smart constructor.

Instances

Eq StepProperties

Data StepProperties

Show StepProperties

Generic StepProperties

ToJSON StepProperties

FromJSON StepProperties

type Rep StepProperties

stepProperties

Arguments

:: HashMap Text JSONValue

spAddtional

-> StepProperties

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

spAddtional :: Lens' StepProperties (HashMap Text JSONValue)

Properties of the object.

TopologyConfig

data TopologyConfig

Global topology of the streaming Dataflow job, including all computations and their sharded locations.

See: topologyConfig smart constructor.

Instances

Eq TopologyConfig

Data TopologyConfig

Show TopologyConfig

Generic TopologyConfig

ToJSON TopologyConfig

FromJSON TopologyConfig

type Rep TopologyConfig

topologyConfig :: TopologyConfig

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
• tcUserStageToComputationNameMap
• tcComputations

tcDataDiskAssignments :: Lens' TopologyConfig [DataDiskAssignment]

The disks assigned to a streaming Dataflow job.

tcUserStageToComputationNameMap :: Lens' TopologyConfig (Maybe TopologyConfigUserStageToComputationNameMap)

Maps user stage names to stable computation names.

tcComputations :: Lens' TopologyConfig [ComputationTopology]

The computations associated with a streaming Dataflow job.

WorkerSettings

data WorkerSettings

Provides data to pass through to the worker harness.

See: workerSettings smart constructor.

Instances

Eq WorkerSettings

Data WorkerSettings

Show WorkerSettings

Generic WorkerSettings

ToJSON WorkerSettings

FromJSON WorkerSettings

type Rep WorkerSettings

workerSettings :: WorkerSettings

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
• wsBaseURL
• wsShuffleServicePath
• wsTempStoragePrefix
• wsReportingEnabled
• wsWorkerId

wsServicePath :: Lens' WorkerSettings (Maybe Text)

The Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

wsBaseURL :: Lens' WorkerSettings (Maybe Text)

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)

The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

wsTempStoragePrefix :: Lens' WorkerSettings (Maybe Text)

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)

Send work progress updates to service.

wsWorkerId :: Lens' WorkerSettings (Maybe Text)

ID of the worker running this pipeline.

WorkItemServiceStateHarnessData

data WorkItemServiceStateHarnessData

Other data returned by the service, specific to the particular worker harness.

See: workItemServiceStateHarnessData smart constructor.

Instances

Eq WorkItemServiceStateHarnessData

Data WorkItemServiceStateHarnessData

Show WorkItemServiceStateHarnessData

Generic WorkItemServiceStateHarnessData

ToJSON WorkItemServiceStateHarnessData

FromJSON WorkItemServiceStateHarnessData

type Rep WorkItemServiceStateHarnessData

workItemServiceStateHarnessData

Arguments

:: HashMap Text JSONValue

wisshdAddtional

-> WorkItemServiceStateHarnessData

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

wisshdAddtional :: Lens' WorkItemServiceStateHarnessData (HashMap Text JSONValue)

Properties of the object.

DataDiskAssignment

data DataDiskAssignment

Data disk assignment for a given VM instance.

See: dataDiskAssignment smart constructor.

Instances

Eq DataDiskAssignment

Data DataDiskAssignment

Show DataDiskAssignment

Generic DataDiskAssignment

ToJSON DataDiskAssignment

FromJSON DataDiskAssignment

type Rep DataDiskAssignment

dataDiskAssignment :: DataDiskAssignment

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
• ddaDataDisks

ddaVMInstance :: Lens' DataDiskAssignment (Maybe Text)

VM instance name the data disks mounted to, for example "myproject-1014-104817-4c2-harness-0".

ddaDataDisks :: Lens' DataDiskAssignment [Text]

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" }.

WorkItemServiceState

data WorkItemServiceState

The Dataflow service's idea of the current state of a WorkItem being processed by a worker.

See: workItemServiceState smart constructor.

Instances

Eq WorkItemServiceState

Data WorkItemServiceState

Show WorkItemServiceState

Generic WorkItemServiceState

ToJSON WorkItemServiceState

FromJSON WorkItemServiceState

type Rep WorkItemServiceState

workItemServiceState :: WorkItemServiceState

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
• wissReportStatusInterval
• wissHarnessData
• wissSuggestedStopPoint
• wissSuggestedStopPosition
• wissLeaseExpireTime

wissNextReportIndex :: Lens' WorkItemServiceState (Maybe Int64)

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)

New recommended reporting interval.

wissHarnessData :: Lens' WorkItemServiceState (Maybe WorkItemServiceStateHarnessData)

Other data returned by the service, specific to the particular worker harness.

wissSuggestedStopPoint :: Lens' WorkItemServiceState (Maybe ApproximateProgress)

The progress point in the WorkItem where the Dataflow service suggests that the worker truncate the task.

wissSuggestedStopPosition :: Lens' WorkItemServiceState (Maybe Position)

Obsolete, always empty.

wissLeaseExpireTime :: Lens' WorkItemServiceState (Maybe Text)

Time at which the current lease will expire.

StreamingSetupTask

data StreamingSetupTask

A task which initializes part of a streaming Dataflow job.

See: streamingSetupTask smart constructor.

Instances

Eq StreamingSetupTask

Data StreamingSetupTask

Show StreamingSetupTask

Generic StreamingSetupTask

ToJSON StreamingSetupTask

FromJSON StreamingSetupTask

type Rep StreamingSetupTask

streamingSetupTask :: StreamingSetupTask

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
• sstReceiveWorkPort
• sstWorkerHarnessPort

sstStreamingComputationTopology :: Lens' StreamingSetupTask (Maybe TopologyConfig)

The global topology of the streaming Dataflow job.

sstReceiveWorkPort :: Lens' StreamingSetupTask (Maybe Int32)

The TCP port on which the worker should listen for messages from other streaming computation workers.

sstWorkerHarnessPort :: Lens' StreamingSetupTask (Maybe Int32)

The TCP port used by the worker to communicate with the Dataflow worker harness.

PartialGroupByKeyInstructionInputElementCodec

data PartialGroupByKeyInstructionInputElementCodec

The codec to use for interpreting an element in the input PTable.

See: partialGroupByKeyInstructionInputElementCodec smart constructor.

Instances

Eq PartialGroupByKeyInstructionInputElementCodec

Data PartialGroupByKeyInstructionInputElementCodec

Show PartialGroupByKeyInstructionInputElementCodec

Generic PartialGroupByKeyInstructionInputElementCodec

ToJSON PartialGroupByKeyInstructionInputElementCodec

FromJSON PartialGroupByKeyInstructionInputElementCodec

type Rep PartialGroupByKeyInstructionInputElementCodec

partialGroupByKeyInstructionInputElementCodec

Arguments

:: HashMap Text JSONValue

pgbkiiecAddtional

-> PartialGroupByKeyInstructionInputElementCodec

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

pgbkiiecAddtional :: Lens' PartialGroupByKeyInstructionInputElementCodec (HashMap Text JSONValue)

Properties of the object.

MapTask

data 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.

Instances

Eq MapTask

Data MapTask

Show MapTask

Generic MapTask

ToJSON MapTask

FromJSON MapTask

type Rep MapTask

mapTask :: MapTask

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
• mtSystemName
• mtStageName

mtInstructions :: Lens' MapTask [ParallelInstruction]

The instructions in the MapTask.

mtSystemName :: Lens' MapTask (Maybe Text)

System-defined name of this MapTask. Unique across the workflow.

mtStageName :: Lens' MapTask (Maybe Text)

System-defined name of the stage containing this MapTask. Unique across the workflow.

MountedDataDisk

data MountedDataDisk

Describes mounted data disk.

See: mountedDataDisk smart constructor.

Instances

Eq MountedDataDisk

Data MountedDataDisk

Show MountedDataDisk

Generic MountedDataDisk

ToJSON MountedDataDisk

FromJSON MountedDataDisk

type Rep MountedDataDisk

mountedDataDisk :: MountedDataDisk

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

mddDataDisk :: Lens' MountedDataDisk (Maybe Text)

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

data SinkCodec

The codec to use to encode data written to the sink.

See: sinkCodec smart constructor.

Instances

Eq SinkCodec

Data SinkCodec

Show SinkCodec

Generic SinkCodec

ToJSON SinkCodec

FromJSON SinkCodec

type Rep SinkCodec

sinkCodec

Arguments

:: HashMap Text JSONValue

scAddtional

-> SinkCodec

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:

• scAddtional

scAddtional :: Lens' SinkCodec (HashMap Text JSONValue)

Properties of the object.

ParDoInstructionUserFn

data ParDoInstructionUserFn

The user function to invoke.

See: parDoInstructionUserFn smart constructor.

Instances

Eq ParDoInstructionUserFn

Data ParDoInstructionUserFn

Show ParDoInstructionUserFn

Generic ParDoInstructionUserFn

ToJSON ParDoInstructionUserFn

FromJSON ParDoInstructionUserFn

type Rep ParDoInstructionUserFn

parDoInstructionUserFn

Arguments

:: HashMap Text JSONValue

pdiufAddtional

-> ParDoInstructionUserFn

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

pdiufAddtional :: Lens' ParDoInstructionUserFn (HashMap Text JSONValue)

Properties of the object.

InstructionOutputCodec

data InstructionOutputCodec

The codec to use to encode data being written via this output.

See: instructionOutputCodec smart constructor.

Instances

Eq InstructionOutputCodec

Data InstructionOutputCodec

Show InstructionOutputCodec

Generic InstructionOutputCodec

ToJSON InstructionOutputCodec

FromJSON InstructionOutputCodec

type Rep InstructionOutputCodec

instructionOutputCodec

Arguments

:: HashMap Text JSONValue

iocAddtional

-> InstructionOutputCodec

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

iocAddtional :: Lens' InstructionOutputCodec (HashMap Text JSONValue)

Properties of the object.

StreamLocation

data StreamLocation

Describes a stream of data, either as input to be processed or as output of a streaming Dataflow job.

See: streamLocation smart constructor.

Instances

Eq StreamLocation

Data StreamLocation

Show StreamLocation

Generic StreamLocation

ToJSON StreamLocation

FromJSON StreamLocation

type Rep StreamLocation

streamLocation :: StreamLocation

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
• slSideInputLocation
• slCustomSourceLocation
• slPubsubLocation

slStreamingStageLocation :: Lens' StreamLocation (Maybe StreamingStageLocation)

The stream is part of another computation within the current streaming Dataflow job.

slSideInputLocation :: Lens' StreamLocation (Maybe StreamingSideInputLocation)

The stream is a streaming side input.

slCustomSourceLocation :: Lens' StreamLocation (Maybe CustomSourceLocation)

The stream is a custom source.

slPubsubLocation :: Lens' StreamLocation (Maybe PubsubLocation)

The stream is a pubsub stream.

WorkerPoolPoolArgs

data WorkerPoolPoolArgs

Extra arguments for this worker pool.

See: workerPoolPoolArgs smart constructor.

Instances

Eq WorkerPoolPoolArgs

Data WorkerPoolPoolArgs

Show WorkerPoolPoolArgs

Generic WorkerPoolPoolArgs

ToJSON WorkerPoolPoolArgs

FromJSON WorkerPoolPoolArgs

type Rep WorkerPoolPoolArgs

workerPoolPoolArgs

Arguments

:: HashMap Text JSONValue

wppaAddtional

-> WorkerPoolPoolArgs

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

wppaAddtional :: Lens' WorkerPoolPoolArgs (HashMap Text JSONValue)

Properties of the object. Contains field 'ype with type URL.

StreamingSideInputLocation

data StreamingSideInputLocation

Identifies the location of a streaming side input.

See: streamingSideInputLocation smart constructor.

Instances

Eq StreamingSideInputLocation

Data StreamingSideInputLocation

Show StreamingSideInputLocation

Generic StreamingSideInputLocation

ToJSON StreamingSideInputLocation

FromJSON StreamingSideInputLocation

type Rep StreamingSideInputLocation

streamingSideInputLocation :: StreamingSideInputLocation

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
• ssilStateFamily

ssilTag :: Lens' StreamingSideInputLocation (Maybe Text)

Identifies the particular side input within the streaming Dataflow job.

ssilStateFamily :: Lens' StreamingSideInputLocation (Maybe Text)

Identifies the state family where this side input is stored.

StreamingComputationTask

data StreamingComputationTask

A task which describes what action should be performed for the specified streaming computation ranges.

See: streamingComputationTask smart constructor.

Instances

Eq StreamingComputationTask

Data StreamingComputationTask

Show StreamingComputationTask

Generic StreamingComputationTask

ToJSON StreamingComputationTask

FromJSON StreamingComputationTask

type Rep StreamingComputationTask

streamingComputationTask :: StreamingComputationTask

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
• sctDataDisks
• sctComputationRanges

sctTaskType :: Lens' StreamingComputationTask (Maybe Text)

A type of streaming computation task.

sctDataDisks :: Lens' StreamingComputationTask [MountedDataDisk]

Describes the set of data disks this task should apply to.

sctComputationRanges :: Lens' StreamingComputationTask [StreamingComputationRanges]

Contains ranges of a streaming computation this task should apply to.

JobMessage

data JobMessage

A particular message pertaining to a Dataflow job.

See: jobMessage smart constructor.

Instances

Eq JobMessage

Data JobMessage

Show JobMessage

Generic JobMessage

ToJSON JobMessage

FromJSON JobMessage

type Rep JobMessage

jobMessage :: JobMessage

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:

• jmTime
• jmMessageText
• jmMessageImportance
• jmId

jmTime :: Lens' JobMessage (Maybe Text)

The timestamp of the message.

jmMessageText :: Lens' JobMessage (Maybe Text)

The text of the message.

jmMessageImportance :: Lens' JobMessage (Maybe Text)

Importance level of the message.

jmId :: Lens' JobMessage (Maybe Text)

Identifies the message. This is automatically generated by the service; the caller should treat it as an opaque string.

SeqMapTaskOutputInfo

data SeqMapTaskOutputInfo

Information about an output of a SeqMapTask.

See: seqMapTaskOutputInfo smart constructor.

Instances

Eq SeqMapTaskOutputInfo

Data SeqMapTaskOutputInfo

Show SeqMapTaskOutputInfo

Generic SeqMapTaskOutputInfo

ToJSON SeqMapTaskOutputInfo

FromJSON SeqMapTaskOutputInfo

type Rep SeqMapTaskOutputInfo

seqMapTaskOutputInfo :: SeqMapTaskOutputInfo

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:

• smtoiSink
• smtoiTag

smtoiSink :: Lens' SeqMapTaskOutputInfo (Maybe Sink)

The sink to write the output value to.

smtoiTag :: Lens' SeqMapTaskOutputInfo (Maybe Text)

The id of the TupleTag the user code will tag the output value by.

SourceGetMetadataRequest

data SourceGetMetadataRequest

A request to compute the SourceMetadata of a Source.

See: sourceGetMetadataRequest smart constructor.

Instances

Eq SourceGetMetadataRequest

Data SourceGetMetadataRequest

Show SourceGetMetadataRequest

Generic SourceGetMetadataRequest

ToJSON SourceGetMetadataRequest

FromJSON SourceGetMetadataRequest

type Rep SourceGetMetadataRequest

sourceGetMetadataRequest :: SourceGetMetadataRequest

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

sgmrSource :: Lens' SourceGetMetadataRequest (Maybe Source)

Specification of the source whose metadata should be computed.

SeqMapTaskUserFn

data SeqMapTaskUserFn

The user function to invoke.

See: seqMapTaskUserFn smart constructor.

Instances

Eq SeqMapTaskUserFn

Data SeqMapTaskUserFn

Show SeqMapTaskUserFn

Generic SeqMapTaskUserFn

ToJSON SeqMapTaskUserFn

FromJSON SeqMapTaskUserFn

type Rep SeqMapTaskUserFn

seqMapTaskUserFn

Arguments

:: HashMap Text JSONValue

smtufAddtional

-> SeqMapTaskUserFn

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

smtufAddtional :: Lens' SeqMapTaskUserFn (HashMap Text JSONValue)

Properties of the object.

PartialGroupByKeyInstructionValueCombiningFn

data PartialGroupByKeyInstructionValueCombiningFn

The value combining function to invoke.

See: partialGroupByKeyInstructionValueCombiningFn smart constructor.

Instances

Eq PartialGroupByKeyInstructionValueCombiningFn

Data PartialGroupByKeyInstructionValueCombiningFn

Show PartialGroupByKeyInstructionValueCombiningFn

Generic PartialGroupByKeyInstructionValueCombiningFn

ToJSON PartialGroupByKeyInstructionValueCombiningFn

FromJSON PartialGroupByKeyInstructionValueCombiningFn

type Rep PartialGroupByKeyInstructionValueCombiningFn

partialGroupByKeyInstructionValueCombiningFn

Arguments

:: HashMap Text JSONValue

pgbkivcfAddtional

-> PartialGroupByKeyInstructionValueCombiningFn

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

pgbkivcfAddtional :: Lens' PartialGroupByKeyInstructionValueCombiningFn (HashMap Text JSONValue)

Properties of the object.

Job

data Job

Defines a job to be run by the Dataflow service.

See: job smart constructor.

Instances

Eq Job

Data Job

Show Job

Generic Job

ToJSON Job

FromJSON Job

type Rep Job

job :: Job

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
• jEnvironment
• jClientRequestId
• jCurrentState
• jReplacedByJobId
• jSteps
• jExecutionInfo
• jName
• jTransformNameMApping
• jId
• jProjectId
• jType
• jCurrentStateTime
• jReplaceJobId
• jCreateTime

jRequestedState :: Lens' Job (Maybe Text)

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)

Environment for the job.

jClientRequestId :: Lens' Job (Maybe Text)

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)

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)

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.

jSteps :: Lens' Job [Step]

The top-level steps that constitute the entire job.

jExecutionInfo :: Lens' Job (Maybe JobExecutionInfo)

Information about how the Dataflow service will actually run the job.

jName :: Lens' Job (Maybe Text)

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)

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)

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.

jProjectId :: Lens' Job (Maybe Text)

The project which owns the job.

jType :: Lens' Job (Maybe Text)

The type of dataflow job.

jCurrentStateTime :: Lens' Job (Maybe Text)

The timestamp associated with the current state.

jReplaceJobId :: Lens' Job (Maybe Text)

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)

Timestamp when job was initially created. Immutable, set by the Dataflow service.

ReadInstruction

data ReadInstruction

An instruction that reads records. Takes no inputs, produces one output.

See: readInstruction smart constructor.

Instances

Eq ReadInstruction

Data ReadInstruction

Show ReadInstruction

Generic ReadInstruction

ToJSON ReadInstruction

FromJSON ReadInstruction

type Rep ReadInstruction

readInstruction :: ReadInstruction

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:

• riSource

riSource :: Lens' ReadInstruction (Maybe Source)

The source to read from.

SinkSpec

data SinkSpec

The sink to write to, plus its parameters.

See: sinkSpec smart constructor.

Instances

Eq SinkSpec

Data SinkSpec

Show SinkSpec

Generic SinkSpec

ToJSON SinkSpec

FromJSON SinkSpec

type Rep SinkSpec

sinkSpec

Arguments

:: HashMap Text JSONValue

sAddtional

-> SinkSpec

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:

• sAddtional

sAddtional :: Lens' SinkSpec (HashMap Text JSONValue)

Properties of the object.

WorkerPool

data WorkerPool

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.

Instances

Eq WorkerPool

Data WorkerPool

Show WorkerPool

Generic WorkerPool

ToJSON WorkerPool

FromJSON WorkerPool

type Rep WorkerPool

workerPool :: WorkerPool

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
• wpDiskSizeGb
• wpKind
• wpTaskrunnerSettings
• wpNumWorkers
• wpNetwork
• wpZone
• wpPackages
• wpOnHostMaintenance
• wpDiskSourceImage
• wpMachineType
• wpMetadata
• wpDiskType
• wpTeardownPolicy
• wpDefaultPackageSet
• wpPoolArgs
• wpDataDisks

wpAutoscalingSettings :: Lens' WorkerPool (Maybe AutoscalingSettings)

Settings for autoscaling of this WorkerPool.

wpDiskSizeGb :: Lens' WorkerPool (Maybe Int32)

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)

The kind of the worker pool; currently only 'harness' and 'shuffle' are supported.

wpTaskrunnerSettings :: Lens' WorkerPool (Maybe TaskRunnerSettings)

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)

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)

Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

wpZone :: Lens' WorkerPool (Maybe Text)

Zone to run the worker pools in (e.g. "us-central1-b"). If empty or unspecified, the service will attempt to choose a reasonable default.

wpPackages :: Lens' WorkerPool [Package]

Packages to be installed on workers.

wpOnHostMaintenance :: Lens' WorkerPool (Maybe Text)

The action to take on host maintenance, as defined by the Google Compute Engine API.

wpDiskSourceImage :: Lens' WorkerPool (Maybe Text)

Fully qualified source image for disks.

wpMachineType :: Lens' WorkerPool (Maybe Text)

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)

Metadata to set on the Google Compute Engine VMs.

wpDiskType :: Lens' WorkerPool (Maybe Text)

Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

wpTeardownPolicy :: Lens' WorkerPool (Maybe Text)

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)

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)

Extra arguments for this worker pool.

wpDataDisks :: Lens' WorkerPool [Disk]

Data disks that are used by a VM in this workflow.

Step

data 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.

Instances

Eq Step

Data Step

Show Step

Generic Step

ToJSON Step

FromJSON Step

type Rep Step

step :: Step

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:

• sKind
• sName
• sProperties

sKind :: Lens' Step (Maybe Text)

The kind of step in the dataflow Job.

sName :: Lens' Step (Maybe Text)

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)

Named properties associated with the step. Each kind of predefined step has its own required set of properties.

Package

data 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.

Instances

Eq Package

Data Package

Show Package

Generic Package

ToJSON Package

FromJSON Package

type Rep Package

package :: Package

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

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

• pLocation
• pName

pLocation :: Lens' Package (Maybe Text)

The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

pName :: Lens' Package (Maybe Text)

The name of the package.

DynamicSourceSplit

data DynamicSourceSplit

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.

Instances

Eq DynamicSourceSplit

Data DynamicSourceSplit

Show DynamicSourceSplit

Generic DynamicSourceSplit

ToJSON DynamicSourceSplit

FromJSON DynamicSourceSplit

type Rep DynamicSourceSplit

dynamicSourceSplit :: DynamicSourceSplit

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
• dssPrimary

dssResidual :: Lens' DynamicSourceSplit (Maybe DerivedSource)

Residual part (returned to the pool of work). Specified relative to the previously-current source.

dssPrimary :: Lens' DynamicSourceSplit (Maybe DerivedSource)

Primary part (continued to be processed by worker). Specified relative to the previously-current source. Becomes current.

ReportWorkItemStatusResponse

data ReportWorkItemStatusResponse

Response from a request to report the status of WorkItems.

See: reportWorkItemStatusResponse smart constructor.

Instances

Eq ReportWorkItemStatusResponse

Data ReportWorkItemStatusResponse

Show ReportWorkItemStatusResponse

Generic ReportWorkItemStatusResponse

ToJSON ReportWorkItemStatusResponse

FromJSON ReportWorkItemStatusResponse

type Rep ReportWorkItemStatusResponse

reportWorkItemStatusResponse :: ReportWorkItemStatusResponse

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

rwisrWorkItemServiceStates :: Lens' ReportWorkItemStatusResponse [WorkItemServiceState]

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

DEPRECATED in favor of DynamicSourceSplit.

See: sourceFork smart constructor.

Instances

Eq SourceFork

Data SourceFork

Show SourceFork

Generic SourceFork

ToJSON SourceFork

FromJSON SourceFork

type Rep SourceFork

sourceFork :: SourceFork

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
• sfPrimarySource
• sfPrimary
• sfResidualSource

sfResidual :: Lens' SourceFork (Maybe SourceSplitShard)

DEPRECATED

sfPrimarySource :: Lens' SourceFork (Maybe DerivedSource)

DEPRECATED

sfPrimary :: Lens' SourceFork (Maybe SourceSplitShard)

DEPRECATED

sfResidualSource :: Lens' SourceFork (Maybe DerivedSource)

DEPRECATED

StreamingComputationRanges

data StreamingComputationRanges

Describes full or partial data disk assignment information of the computation ranges.

See: streamingComputationRanges smart constructor.

Instances

Eq StreamingComputationRanges

Data StreamingComputationRanges

Show StreamingComputationRanges

Generic StreamingComputationRanges

ToJSON StreamingComputationRanges

FromJSON StreamingComputationRanges

type Rep StreamingComputationRanges

streamingComputationRanges :: StreamingComputationRanges

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
• scrComputationId

scrRangeAssignments :: Lens' StreamingComputationRanges [KeyRangeDataDiskAssignment]

Data disk assignments for ranges from this computation.

scrComputationId :: Lens' StreamingComputationRanges (Maybe Text)

The ID of the computation.

ListJobsResponse

data ListJobsResponse

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.

Instances

Eq ListJobsResponse

Data ListJobsResponse

Show ListJobsResponse

Generic ListJobsResponse

ToJSON ListJobsResponse

FromJSON ListJobsResponse

type Rep ListJobsResponse

listJobsResponse :: ListJobsResponse

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
• ljrJobs

ljrNextPageToken :: Lens' ListJobsResponse (Maybe Text)

Set if there may be more results than fit in this response.

ljrJobs :: Lens' ListJobsResponse [Job]

A subset of the requested job information.

Source

data Source

A source that records can be read and decoded from.

See: source smart constructor.

Instances

Eq Source

Data Source

Show Source

Generic Source

ToJSON Source

FromJSON Source

type Rep Source

source :: Source

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
• souBaseSpecs
• souCodec
• souSpec
• souMetadata

souDoesNotNeedSplitting :: Lens' Source (Maybe Bool)

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]

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)

The codec to use to decode data read from the source.

souSpec :: Lens' Source (Maybe SourceSpec)

The source to read from, plus its parameters.

souMetadata :: Lens' Source (Maybe SourceMetadata)

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

A progress measurement of a WorkItem by a worker.

See: approximateProgress smart constructor.

Instances

Eq ApproximateProgress

Data ApproximateProgress

Show ApproximateProgress

Generic ApproximateProgress

ToJSON ApproximateProgress

FromJSON ApproximateProgress

type Rep ApproximateProgress

approximateProgress :: ApproximateProgress

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
• apPercentComplete
• apPosition

apRemainingTime :: Lens' ApproximateProgress (Maybe Text)

Completion as an estimated time remaining.

apPercentComplete :: Lens' ApproximateProgress (Maybe Double)

Completion as percentage of the work, from 0.0 (beginning, nothing complete), to 1.0 (end of the work range, entire WorkItem complete).

apPosition :: Lens' ApproximateProgress (Maybe Position)

A Position within the work to represent a progress.

KeyRangeLocation

data KeyRangeLocation

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.

Instances

Eq KeyRangeLocation

Data KeyRangeLocation

Show KeyRangeLocation

Generic KeyRangeLocation

ToJSON KeyRangeLocation

FromJSON KeyRangeLocation

type Rep KeyRangeLocation

keyRangeLocation :: KeyRangeLocation

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
• krlDataDisk
• krlStart
• krlDeliveryEndpoint
• krlEnd

krlPersistentDirectory :: Lens' KeyRangeLocation (Maybe Text)

The location of the persistent state for this range, as a persistent directory in the worker local filesystem.

krlDataDisk :: Lens' KeyRangeLocation (Maybe Text)

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".

krlStart :: Lens' KeyRangeLocation (Maybe Text)

The start (inclusive) of the key range.

krlDeliveryEndpoint :: Lens' KeyRangeLocation (Maybe Text)

The physical location of this range assignment to be used for streaming computation cross-worker message delivery.

krlEnd :: Lens' KeyRangeLocation (Maybe Text)

The end (exclusive) of the key range.

MultiOutputInfo

data MultiOutputInfo

Information about an output of a multi-output DoFn.

See: multiOutputInfo smart constructor.

Instances

Eq MultiOutputInfo

Data MultiOutputInfo

Show MultiOutputInfo

Generic MultiOutputInfo

ToJSON MultiOutputInfo

FromJSON MultiOutputInfo

type Rep MultiOutputInfo

multiOutputInfo :: MultiOutputInfo

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

moiTag :: Lens' MultiOutputInfo (Maybe Text)

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

An instruction that does a partial group-by-key. One input and one output.

See: partialGroupByKeyInstruction smart constructor.

Instances

Eq PartialGroupByKeyInstruction

Data PartialGroupByKeyInstruction

Show PartialGroupByKeyInstruction

Generic PartialGroupByKeyInstruction

ToJSON PartialGroupByKeyInstruction

FromJSON PartialGroupByKeyInstruction

type Rep PartialGroupByKeyInstruction

partialGroupByKeyInstruction :: PartialGroupByKeyInstruction

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
• pgbkiInput
• pgbkiInputElementCodec

pgbkiValueCombiningFn :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionValueCombiningFn)

The value combining function to invoke.

pgbkiInput :: Lens' PartialGroupByKeyInstruction (Maybe InstructionInput)

Describes the input to the partial group-by-key instruction.

pgbkiInputElementCodec :: Lens' PartialGroupByKeyInstruction (Maybe PartialGroupByKeyInstructionInputElementCodec)

The codec to use for interpreting an element in the input PTable.

ParDoInstruction

data ParDoInstruction

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.

Instances

Eq ParDoInstruction

Data ParDoInstruction

Show ParDoInstruction

Generic ParDoInstruction

ToJSON ParDoInstruction

FromJSON ParDoInstruction

type Rep ParDoInstruction

parDoInstruction :: ParDoInstruction

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
• pdiMultiOutputInfos
• pdiSideInputs
• pdiInput
• pdiUserFn

pdiNumOutputs :: Lens' ParDoInstruction (Maybe Int32)

The number of outputs.

pdiMultiOutputInfos :: Lens' ParDoInstruction [MultiOutputInfo]

Information about each of the outputs, if user_fn is a MultiDoFn.

pdiSideInputs :: Lens' ParDoInstruction [SideInputInfo]

Zero or more side inputs.

pdiInput :: Lens' ParDoInstruction (Maybe InstructionInput)

The input.

pdiUserFn :: Lens' ParDoInstruction (Maybe ParDoInstructionUserFn)

The user function to invoke.

CustomSourceLocation

data CustomSourceLocation

Identifies the location of a custom souce.

See: customSourceLocation smart constructor.

Instances

Eq CustomSourceLocation

Data CustomSourceLocation

Show CustomSourceLocation

Generic CustomSourceLocation

ToJSON CustomSourceLocation

FromJSON CustomSourceLocation

type Rep CustomSourceLocation

customSourceLocation :: CustomSourceLocation

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

cslStateful :: Lens' CustomSourceLocation (Maybe Bool)

Whether this source is stateful.

SourceBaseSpecsItem

data SourceBaseSpecsItem

Instances

Eq SourceBaseSpecsItem

Data SourceBaseSpecsItem

Show SourceBaseSpecsItem

Generic SourceBaseSpecsItem

ToJSON SourceBaseSpecsItem

FromJSON SourceBaseSpecsItem

type Rep SourceBaseSpecsItem

sourceBaseSpecsItem

Arguments

:: HashMap Text JSONValue

sbsiAddtional

-> SourceBaseSpecsItem

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

sbsiAddtional :: Lens' SourceBaseSpecsItem (HashMap Text JSONValue)

Properties of the object.

ParallelInstruction

data ParallelInstruction

Describes a particular operation comprising a MapTask.

See: parallelInstruction smart constructor.

Instances

Eq ParallelInstruction

Data ParallelInstruction

Show ParallelInstruction

Generic ParallelInstruction

ToJSON ParallelInstruction

FromJSON ParallelInstruction

type Rep ParallelInstruction

parallelInstruction :: ParallelInstruction

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
• piWrite
• piParDo
• piPartialGroupByKey
• piOutputs
• piName
• piSystemName
• piFlatten

piRead :: Lens' ParallelInstruction (Maybe ReadInstruction)

Additional information for Read instructions.

piWrite :: Lens' ParallelInstruction (Maybe WriteInstruction)

Additional information for Write instructions.

piParDo :: Lens' ParallelInstruction (Maybe ParDoInstruction)

Additional information for ParDo instructions.

piPartialGroupByKey :: Lens' ParallelInstruction (Maybe PartialGroupByKeyInstruction)

Additional information for PartialGroupByKey instructions.

piOutputs :: Lens' ParallelInstruction [InstructionOutput]

Describes the outputs of the instruction.

piName :: Lens' ParallelInstruction (Maybe Text)

User-provided name of this operation.

piSystemName :: Lens' ParallelInstruction (Maybe Text)

System-defined name of this operation. Unique across the workflow.

piFlatten :: Lens' ParallelInstruction (Maybe FlattenInstruction)

Additional information for Flatten instructions.

SideInputInfoKind

data SideInputInfoKind

How to interpret the source element(s) as a side input value.

See: sideInputInfoKind smart constructor.

Instances

Eq SideInputInfoKind

Data SideInputInfoKind

Show SideInputInfoKind

Generic SideInputInfoKind

ToJSON SideInputInfoKind

FromJSON SideInputInfoKind

type Rep SideInputInfoKind

sideInputInfoKind

Arguments

:: HashMap Text JSONValue

siikAddtional

-> SideInputInfoKind

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

siikAddtional :: Lens' SideInputInfoKind (HashMap Text JSONValue)

Properties of the object.

SourceSplitShard

data SourceSplitShard

DEPRECATED in favor of DerivedSource.

See: sourceSplitShard smart constructor.

Instances

Eq SourceSplitShard

Data SourceSplitShard

Show SourceSplitShard

Generic SourceSplitShard

ToJSON SourceSplitShard

FromJSON SourceSplitShard

type Rep SourceSplitShard

sourceSplitShard :: SourceSplitShard

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
• sssSource

sssDerivationMode :: Lens' SourceSplitShard (Maybe Text)

DEPRECATED

sssSource :: Lens' SourceSplitShard (Maybe Source)

DEPRECATED

SideInputInfo

data SideInputInfo

Information about a side input of a DoFn or an input of a SeqDoFn.

See: sideInputInfo smart constructor.

Instances

Eq SideInputInfo

Data SideInputInfo

Show SideInputInfo

Generic SideInputInfo

ToJSON SideInputInfo

FromJSON SideInputInfo

type Rep SideInputInfo

sideInputInfo :: SideInputInfo

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
• siiKind
• siiSources

siiTag :: Lens' SideInputInfo (Maybe Text)

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)

How to interpret the source element(s) as a side input value.

siiSources :: Lens' SideInputInfo [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

Additional information about how a Dataflow job will be executed which isn’t contained in the submitted job.

See: jobExecutionInfo smart constructor.

Instances

Eq JobExecutionInfo

Data JobExecutionInfo

Show JobExecutionInfo

Generic JobExecutionInfo

ToJSON JobExecutionInfo

FromJSON JobExecutionInfo

type Rep JobExecutionInfo

jobExecutionInfo :: JobExecutionInfo

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

jeiStages :: Lens' JobExecutionInfo (Maybe JobExecutionInfoStages)

A mapping from each stage to the information about that stage.

SourceCodec

data SourceCodec

The codec to use to decode data read from the source.

See: sourceCodec smart constructor.

Instances

Eq SourceCodec

Data SourceCodec

Show SourceCodec

Generic SourceCodec

ToJSON SourceCodec

FromJSON SourceCodec

type Rep SourceCodec

sourceCodec

Arguments

:: HashMap Text JSONValue

souAddtional

-> SourceCodec

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

souAddtional :: Lens' SourceCodec (HashMap Text JSONValue)

Properties of the object.

StateFamilyConfig

data StateFamilyConfig

State family configuration.

See: stateFamilyConfig smart constructor.

Instances

Eq StateFamilyConfig

Data StateFamilyConfig

Show StateFamilyConfig

Generic StateFamilyConfig

ToJSON StateFamilyConfig

FromJSON StateFamilyConfig

type Rep StateFamilyConfig

stateFamilyConfig :: StateFamilyConfig

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
• sfcStateFamily

sfcIsRead :: Lens' StateFamilyConfig (Maybe Bool)

If true, this family corresponds to a read operation.

sfcStateFamily :: Lens' StateFamilyConfig (Maybe Text)

The state family value.

KeyRangeDataDiskAssignment

data KeyRangeDataDiskAssignment

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.

Instances

Eq KeyRangeDataDiskAssignment

Data KeyRangeDataDiskAssignment

Show KeyRangeDataDiskAssignment

Generic KeyRangeDataDiskAssignment

ToJSON KeyRangeDataDiskAssignment

FromJSON KeyRangeDataDiskAssignment

type Rep KeyRangeDataDiskAssignment

keyRangeDataDiskAssignment :: KeyRangeDataDiskAssignment

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
• krddaStart
• krddaEnd

krddaDataDisk :: Lens' KeyRangeDataDiskAssignment (Maybe Text)

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)

The start (inclusive) of the key range.

krddaEnd :: Lens' KeyRangeDataDiskAssignment (Maybe Text)

The end (exclusive) of the key range.

SourceSplitRequest

data SourceSplitRequest

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.

Instances

Eq SourceSplitRequest

Data SourceSplitRequest

Show SourceSplitRequest

Generic SourceSplitRequest

ToJSON SourceSplitRequest

FromJSON SourceSplitRequest

type Rep SourceSplitRequest

sourceSplitRequest :: SourceSplitRequest

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
• ssrOptions

ssrSource :: Lens' SourceSplitRequest (Maybe Source)

Specification of the source to be split.

ssrOptions :: Lens' SourceSplitRequest (Maybe SourceSplitOptions)

Hints for tuning the splitting process.

ListJobMessagesResponse

data ListJobMessagesResponse

Response to a request to list job messages.

See: listJobMessagesResponse smart constructor.

Instances

Eq ListJobMessagesResponse

Data ListJobMessagesResponse

Show ListJobMessagesResponse

Generic ListJobMessagesResponse

ToJSON ListJobMessagesResponse

FromJSON ListJobMessagesResponse

type Rep ListJobMessagesResponse

listJobMessagesResponse :: ListJobMessagesResponse

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
• ljmrNextPageToken

ljmrJobMessages :: Lens' ListJobMessagesResponse [JobMessage]

Messages in ascending timestamp order.

ljmrNextPageToken :: Lens' ListJobMessagesResponse (Maybe Text)

The token to obtain the next page of results if there are more.

PubsubLocation

data PubsubLocation

Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job.

See: pubsubLocation smart constructor.

Instances

Eq PubsubLocation

Data PubsubLocation

Show PubsubLocation

Generic PubsubLocation

ToJSON PubsubLocation

FromJSON PubsubLocation

type Rep PubsubLocation

pubsubLocation :: PubsubLocation

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
• plDropLateData
• plTimestampLabel
• plIdLabel
• plTopic
• plSubscription

plTrackingSubscription :: Lens' PubsubLocation (Maybe Text)

If set, specifies the pubsub subscription that will be used for tracking custom time timestamps for watermark estimation.

plDropLateData :: Lens' PubsubLocation (Maybe Bool)

Indicates whether the pipeline allows late-arriving data.

plTimestampLabel :: Lens' PubsubLocation (Maybe Text)

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)

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)

A pubsub topic, in the form of "pubsub.googleapis.com/topics/ /"

plSubscription :: Lens' PubsubLocation (Maybe Text)

A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions/ /"

InstructionInput

data InstructionInput

An input of an instruction, as a reference to an output of a producer instruction.

See: instructionInput smart constructor.

Instances

Eq InstructionInput

Data InstructionInput

Show InstructionInput

Generic InstructionInput

ToJSON InstructionInput

FromJSON InstructionInput

type Rep InstructionInput

instructionInput :: InstructionInput

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
• iiOutputNum

iiProducerInstructionIndex :: Lens' InstructionInput (Maybe Int32)

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)

The output index (origin zero) within the producer.

SeqMapTask

data SeqMapTask

Describes a particular function to invoke.

See: seqMapTask smart constructor.

Instances

Eq SeqMapTask

Data SeqMapTask

Show SeqMapTask

Generic SeqMapTask

ToJSON SeqMapTask

FromJSON SeqMapTask

type Rep SeqMapTask

seqMapTask :: SeqMapTask

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
• smtName
• smtOutputInfos
• smtSystemName
• smtStageName
• smtUserFn

smtInputs :: Lens' SeqMapTask [SideInputInfo]

Information about each of the inputs.

smtName :: Lens' SeqMapTask (Maybe Text)

The user-provided name of the SeqDo operation.

smtOutputInfos :: Lens' SeqMapTask [SeqMapTaskOutputInfo]

Information about each of the outputs.

smtSystemName :: Lens' SeqMapTask (Maybe Text)

System-defined name of the SeqDo operation. Unique across the workflow.

smtStageName :: Lens' SeqMapTask (Maybe Text)

System-defined name of the stage containing the SeqDo operation. Unique across the workflow.

smtUserFn :: Lens' SeqMapTask (Maybe SeqMapTaskUserFn)

The user function to invoke.

SourceOperationRequest

data SourceOperationRequest

A work item that represents the different operations that can be performed on a user-defined Source specification.

See: sourceOperationRequest smart constructor.

Instances

Eq SourceOperationRequest

Data SourceOperationRequest

Show SourceOperationRequest

Generic SourceOperationRequest

ToJSON SourceOperationRequest

FromJSON SourceOperationRequest

type Rep SourceOperationRequest

sourceOperationRequest :: SourceOperationRequest

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
• sGetMetadata

sSplit :: Lens' SourceOperationRequest (Maybe SourceSplitRequest)

Information about a request to split a source.

sGetMetadata :: Lens' SourceOperationRequest (Maybe SourceGetMetadataRequest)

Information about a request to get metadata about a source.

LeaseWorkItemResponse

data LeaseWorkItemResponse

Response to a request to lease WorkItems.

See: leaseWorkItemResponse smart constructor.

Instances

Eq LeaseWorkItemResponse

Data LeaseWorkItemResponse

Show LeaseWorkItemResponse

Generic LeaseWorkItemResponse

ToJSON LeaseWorkItemResponse

FromJSON LeaseWorkItemResponse

type Rep LeaseWorkItemResponse

leaseWorkItemResponse :: LeaseWorkItemResponse

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

lwirWorkItems :: Lens' LeaseWorkItemResponse [WorkItem]

A list of the leased WorkItems.

Position

data 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.

Instances

Eq Position

Data Position

Show Position

Generic Position

ToJSON Position

FromJSON Position

type Rep Position

position :: Position

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:

• pByteOffSet
• pConcatPosition
• pRecordIndex
• pShufflePosition
• pKey
• pEnd

pByteOffSet :: Lens' Position (Maybe Int64)

Position is a byte offset.

pConcatPosition :: Lens' Position (Maybe ConcatPosition)

CloudPosition is a concat position.

pRecordIndex :: Lens' Position (Maybe Int64)

Position is a record index.

pShufflePosition :: Lens' Position (Maybe Text)

CloudPosition is a base64 encoded BatchShufflePosition (with FIXED sharding).

pKey :: Lens' Position (Maybe Text)

Position is a string key, ordered lexicographically.

pEnd :: Lens' Position (Maybe Bool)

Position is past all other positions. Also useful for the end position of an unbounded range.