dataflow library

Classes

AutoscalingSettings
Settings for WorkerPool autoscaling.
AutoscalingSettingsResponse
Settings for WorkerPool autoscaling.
BigQueryIODetails
Metadata for a BigQuery connector used by the job.
BigQueryIODetailsResponse
Metadata for a BigQuery connector used by the job.
BigTableIODetails
Metadata for a Cloud Bigtable connector used by the job.
BigTableIODetailsResponse
Metadata for a Cloud Bigtable connector used by the job.
ComponentSource
Description of an interstitial value between transforms in an execution stage.
ComponentSourceResponse
Description of an interstitial value between transforms in an execution stage.
ComponentTransform
Description of a transform executed as part of an execution stage.
ComponentTransformResponse
Description of a transform executed as part of an execution stage.
DataSamplingConfig
Configuration options for sampling elements.
DataSamplingConfigResponse
Configuration options for sampling elements.
DatastoreIODetails
Metadata for a Datastore connector used by the job.
DatastoreIODetailsResponse
Metadata for a Datastore connector used by the job.
DebugOptions
Describes any options that have an effect on the debugging of pipelines.
DebugOptionsResponse
Describes any options that have an effect on the debugging of pipelines.
Disk
Describes the data disk used by a workflow job.
DiskResponse
Describes the data disk used by a workflow job.
DisplayData
Data provided with a pipeline or transform to provide descriptive info.
DisplayDataResponse
Data provided with a pipeline or transform to provide descriptive info.
Environment
Describes the environment in which a Dataflow Job runs.
EnvironmentResponse
Describes the environment in which a Dataflow Job runs.
ExecutionStageState
A message describing the state of a particular execution stage.
ExecutionStageStateResponse
A message describing the state of a particular execution stage.
ExecutionStageSummary
Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.
ExecutionStageSummaryResponse
Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning.
FileIODetails
Metadata for a File connector used by the job.
FileIODetailsResponse
Metadata for a File connector used by the job.
GetJobArgs
Arguments for getJob. Arguments for getJob.
GetJobResult
Result data returned by getJob.
GetTemplateArgs
Arguments for getTemplate. Arguments for getTemplate.
GetTemplateResult
Result data returned by getTemplate.
Job
Creates a Cloud Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.create is not recommended, as your job will always start in us-central1. Do not enter confidential information when you supply string values using the API. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
JobArgs
The set of arguments for Job. The set of arguments for Job.
JobExecutionInfo
Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.
JobExecutionInfoResponse
Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.
JobMetadata
Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view.
JobMetadataResponse
Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view.
Package
The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud 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.
PackageResponse
The packages that must be installed in order for a worker to run the steps of the Cloud Dataflow job that will be assigned to its worker pool. This is the mechanism by which the Cloud Dataflow SDK causes code to be loaded onto the workers. For example, the Cloud 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.
ParameterMetadataEnumOptionResponse
ParameterMetadataEnumOption specifies the option shown in the enum form.
ParameterMetadataResponse
Metadata for a specific parameter.
PipelineDescription
A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics.
PipelineDescriptionResponse
A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics.
PubSubIODetails
Metadata for a Pub/Sub connector used by the job.
PubSubIODetailsResponse
Metadata for a Pub/Sub connector used by the job.
RuntimeEnvironment
The environment values to set at runtime.
RuntimeMetadataResponse
RuntimeMetadata describing a runtime environment.
RuntimeUpdatableParams
Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.
RuntimeUpdatableParamsResponse
Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.
SdkBugResponse
A bug found in the Dataflow SDK.
SdkHarnessContainerImage
Defines an SDK harness container for executing Dataflow pipelines.
SdkHarnessContainerImageResponse
Defines an SDK harness container for executing Dataflow pipelines.
SDKInfoResponse
SDK Information.
SdkVersion
The version of the SDK used to run the job.
SdkVersionResponse
The version of the SDK used to run the job.
SpannerIODetails
Metadata for a Spanner connector used by the job.
SpannerIODetailsResponse
Metadata for a Spanner connector used by the job.
StageSource
Description of an input or output of an execution stage.
StageSourceResponse
Description of an input or output of an execution stage.
StatusResponse
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. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
Step
Defines a particular step within a Cloud 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. Note: The properties of this object are not stable and might change. 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 Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.
StepResponse
Defines a particular step within a Cloud 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. Note: The properties of this object are not stable and might change. 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 Cloud Dataflow service may be used to run many different types of jobs, not just Map-Reduce.
TaskRunnerSettings
Taskrunner configuration settings.
TaskRunnerSettingsResponse
Taskrunner configuration settings.
Template
Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. Auto-naming is currently not supported for this resource. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
TemplateArgs
The set of arguments for Template. The set of arguments for Template.
TemplateMetadataResponse
Metadata describing a template.
TransformSummary
Description of the type, names/ids, and input/outputs for a transform.
TransformSummaryResponse
Description of the type, names/ids, and input/outputs for a transform.
WorkerPool
Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud 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.
WorkerPoolResponse
Describes one particular pool of Cloud Dataflow workers to be instantiated by the Cloud 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.
WorkerSettings
Provides data to pass through to the worker harness.
WorkerSettingsResponse
Provides data to pass through to the worker harness.

Enums

AutoscalingSettingsAlgorithm
The algorithm to use for autoscaling.
DataSamplingConfigBehaviorsItem
EnvironmentFlexResourceSchedulingGoal
Which Flexible Resource Scheduling mode to run in.
ExecutionStageStateExecutionStageState
Executions stage states allow the same set of values as JobState.
ExecutionStageSummaryKind
Type of transform this stage is executing.
JobCurrentState
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. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
JobRequestedState
The job's requested state. Applies to UpdateJob requests. Set requested_state with UpdateJob requests to switch between the states JOB_STATE_STOPPED and JOB_STATE_RUNNING. You can also use UpdateJob requests to change a job's state from JOB_STATE_RUNNING to JOB_STATE_CANCELLED, JOB_STATE_DONE, or JOB_STATE_DRAINED. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on CreateJob requests.
JobType
The type of Cloud Dataflow job.
RuntimeEnvironmentIpConfiguration
Optional. Configuration for VM IPs.
SdkVersionSdkSupportStatus
The support status for this SDK version.
TransformSummaryKind
Type of transform.
WorkerPoolDefaultPackageSet
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.
WorkerPoolIpConfiguration
Configuration for VM IPs.
WorkerPoolTeardownPolicy
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.

Functions

getJob(GetJobArgs args, {InvokeOptions? options}) → Future<GetJobResult>
Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using projects.locations.jobs.get with a regional endpoint (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1. args Arguments passed to this invoke. Arguments for getJob. options Invoke options controlling this call.
getTemplate(GetTemplateArgs args, {InvokeOptions? options}) → Future<GetTemplateResult>
Get the template associated with a template. args Arguments passed to this invoke. Arguments for getTemplate. options Invoke options controlling this call.