Package-level declarations

Types

Link copied to clipboard
data class AutoscalingSettingsArgs(val algorithm: Output<AutoscalingSettingsAlgorithm>? = null, val maxNumWorkers: Output<Int>? = null) : ConvertibleToJava<AutoscalingSettingsArgs>

Settings for WorkerPool autoscaling.

Link copied to clipboard
data class BigQueryIODetailsArgs(val dataset: Output<String>? = null, val project: Output<String>? = null, val query: Output<String>? = null, val table: Output<String>? = null) : ConvertibleToJava<BigQueryIODetailsArgs>

Metadata for a BigQuery connector used by the job.

Link copied to clipboard
data class BigTableIODetailsArgs(val instanceId: Output<String>? = null, val project: Output<String>? = null, val tableId: Output<String>? = null) : ConvertibleToJava<BigTableIODetailsArgs>

Metadata for a Cloud Bigtable connector used by the job.

Link copied to clipboard
data class ComponentSourceArgs(val name: Output<String>? = null, val originalTransformOrCollection: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<ComponentSourceArgs>

Description of an interstitial value between transforms in an execution stage.

Link copied to clipboard
data class ComponentTransformArgs(val name: Output<String>? = null, val originalTransform: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<ComponentTransformArgs>

Description of a transform executed as part of an execution stage.

Link copied to clipboard
data class DatastoreIODetailsArgs(val namespace: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<DatastoreIODetailsArgs>

Metadata for a Datastore connector used by the job.

Link copied to clipboard
data class DebugOptionsArgs(val enableHotKeyLogging: Output<Boolean>? = null) : ConvertibleToJava<DebugOptionsArgs>

Describes any options that have an effect on the debugging of pipelines.

Link copied to clipboard
Link copied to clipboard
data class DiskArgs(val diskType: Output<String>? = null, val mountPoint: Output<String>? = null, val sizeGb: Output<Int>? = null) : ConvertibleToJava<DiskArgs>

Describes the data disk used by a workflow job.

Link copied to clipboard

Builder for DiskArgs.

Link copied to clipboard
data class DisplayDataArgs(val boolValue: Output<Boolean>? = null, val durationValue: Output<String>? = null, val floatValue: Output<Double>? = null, val int64Value: Output<String>? = null, val javaClassValue: Output<String>? = null, val key: Output<String>? = null, val label: Output<String>? = null, val namespace: Output<String>? = null, val shortStrValue: Output<String>? = null, val strValue: Output<String>? = null, val timestampValue: Output<String>? = null, val url: Output<String>? = null) : ConvertibleToJava<DisplayDataArgs>

Data provided with a pipeline or transform to provide descriptive info.

Link copied to clipboard
Link copied to clipboard
data class EnvironmentArgs(val clusterManagerApiService: Output<String>? = null, val dataset: Output<String>? = null, val debugOptions: Output<DebugOptionsArgs>? = null, val experiments: Output<List<String>>? = null, val flexResourceSchedulingGoal: Output<EnvironmentFlexResourceSchedulingGoal>? = null, val internalExperiments: Output<Map<String, String>>? = null, val sdkPipelineOptions: Output<Map<String, String>>? = null, val serviceAccountEmail: Output<String>? = null, val serviceKmsKeyName: Output<String>? = null, val serviceOptions: Output<List<String>>? = null, val tempStoragePrefix: Output<String>? = null, val userAgent: Output<Map<String, String>>? = null, val version: Output<Map<String, String>>? = null, val workerPools: Output<List<WorkerPoolArgs>>? = null, val workerRegion: Output<String>? = null, val workerZone: Output<String>? = null) : ConvertibleToJava<EnvironmentArgs>

Describes the environment in which a Dataflow Job runs.

Link copied to clipboard
Link copied to clipboard
data class ExecutionStageStateArgs(val currentStateTime: Output<String>? = null, val executionStageName: Output<String>? = null, val executionStageState: Output<ExecutionStageStateExecutionStageState>? = null) : ConvertibleToJava<ExecutionStageStateArgs>

A message describing the state of a particular execution stage.

Link copied to clipboard
data class ExecutionStageSummaryArgs(val componentSource: Output<List<ComponentSourceArgs>>? = null, val componentTransform: Output<List<ComponentTransformArgs>>? = null, val id: Output<String>? = null, val inputSource: Output<List<StageSourceArgs>>? = null, val kind: Output<ExecutionStageSummaryKind>? = null, val name: Output<String>? = null, val outputSource: Output<List<StageSourceArgs>>? = null, val prerequisiteStage: Output<List<String>>? = null) : ConvertibleToJava<ExecutionStageSummaryArgs>

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.

Link copied to clipboard
data class FileIODetailsArgs(val filePattern: Output<String>? = null) : ConvertibleToJava<FileIODetailsArgs>

Metadata for a File connector used by the job.

Link copied to clipboard
Link copied to clipboard
data class GetJobPlainArgs(val jobId: String, val location: String, val project: String? = null, val view: String? = null) : ConvertibleToJava<GetJobPlainArgs>
Link copied to clipboard
Link copied to clipboard
data class GetTemplatePlainArgs(val gcsPath: String, val location: String, val project: String? = null, val view: String? = null) : ConvertibleToJava<GetTemplatePlainArgs>
Link copied to clipboard
data class JobExecutionInfoArgs(val stages: Output<Map<String, String>>? = null) : ConvertibleToJava<JobExecutionInfoArgs>

Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job.

Link copied to clipboard
data class JobMetadataArgs(val bigTableDetails: Output<List<BigTableIODetailsArgs>>? = null, val bigqueryDetails: Output<List<BigQueryIODetailsArgs>>? = null, val datastoreDetails: Output<List<DatastoreIODetailsArgs>>? = null, val fileDetails: Output<List<FileIODetailsArgs>>? = null, val pubsubDetails: Output<List<PubSubIODetailsArgs>>? = null, val sdkVersion: Output<SdkVersionArgs>? = null, val spannerDetails: Output<List<SpannerIODetailsArgs>>? = null, val userDisplayProperties: Output<Map<String, String>>? = null) : ConvertibleToJava<JobMetadataArgs>

Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view.

Link copied to clipboard
Link copied to clipboard
data class PackageArgs(val location: Output<String>? = null, val name: Output<String>? = null) : ConvertibleToJava<PackageArgs>

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.

Link copied to clipboard
Link copied to clipboard
data class PipelineDescriptionArgs(val displayData: Output<List<DisplayDataArgs>>? = null, val executionPipelineStage: Output<List<ExecutionStageSummaryArgs>>? = null, val originalPipelineTransform: Output<List<TransformSummaryArgs>>? = null, val stepNamesHash: Output<String>? = null) : ConvertibleToJava<PipelineDescriptionArgs>

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.

Link copied to clipboard
data class PubSubIODetailsArgs(val subscription: Output<String>? = null, val topic: Output<String>? = null) : ConvertibleToJava<PubSubIODetailsArgs>

Metadata for a Pub/Sub connector used by the job.

Link copied to clipboard
data class RuntimeEnvironmentArgs(val additionalExperiments: Output<List<String>>? = null, val additionalUserLabels: Output<Map<String, String>>? = null, val bypassTempDirValidation: Output<Boolean>? = null, val enableStreamingEngine: Output<Boolean>? = null, val ipConfiguration: Output<RuntimeEnvironmentIpConfiguration>? = null, val kmsKeyName: Output<String>? = null, val machineType: Output<String>? = null, val maxWorkers: Output<Int>? = null, val network: Output<String>? = null, val numWorkers: Output<Int>? = null, val serviceAccountEmail: Output<String>? = null, val subnetwork: Output<String>? = null, val tempLocation: Output<String>, val workerRegion: Output<String>, val workerZone: Output<String>? = null, val zone: Output<String>? = null) : ConvertibleToJava<RuntimeEnvironmentArgs>

The environment values to set at runtime.

Link copied to clipboard
data class RuntimeUpdatableParamsArgs(val maxNumWorkers: Output<Int>? = null, val minNumWorkers: Output<Int>? = null) : ConvertibleToJava<RuntimeUpdatableParamsArgs>

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.

Link copied to clipboard
data class SdkHarnessContainerImageArgs(val capabilities: Output<List<String>>? = null, val containerImage: Output<String>? = null, val environmentId: Output<String>? = null, val useSingleCorePerContainer: Output<Boolean>? = null) : ConvertibleToJava<SdkHarnessContainerImageArgs>

Defines an SDK harness container for executing Dataflow pipelines.

Link copied to clipboard
data class SdkVersionArgs(val sdkSupportStatus: Output<SdkVersionSdkSupportStatus>? = null, val version: Output<String>? = null, val versionDisplayName: Output<String>? = null) : ConvertibleToJava<SdkVersionArgs>

The version of the SDK used to run the job.

Link copied to clipboard
Link copied to clipboard
data class SpannerIODetailsArgs(val databaseId: Output<String>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null) : ConvertibleToJava<SpannerIODetailsArgs>

Metadata for a Spanner connector used by the job.

Link copied to clipboard
data class StageSourceArgs(val name: Output<String>? = null, val originalTransformOrCollection: Output<String>? = null, val sizeBytes: Output<String>? = null, val userName: Output<String>? = null) : ConvertibleToJava<StageSourceArgs>

Description of an input or output of an execution stage.

Link copied to clipboard
Link copied to clipboard
data class StepArgs(val kind: Output<String>? = null, val name: Output<String>? = null, val properties: Output<Map<String, String>>? = null) : ConvertibleToJava<StepArgs>

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.

Link copied to clipboard

Builder for StepArgs.

Link copied to clipboard
data class TaskRunnerSettingsArgs(val alsologtostderr: Output<Boolean>? = null, val baseTaskDir: Output<String>? = null, val baseUrl: Output<String>? = null, val commandlinesFileName: Output<String>? = null, val continueOnException: Output<Boolean>? = null, val dataflowApiVersion: Output<String>? = null, val harnessCommand: Output<String>? = null, val languageHint: Output<String>? = null, val logDir: Output<String>? = null, val logToSerialconsole: Output<Boolean>? = null, val logUploadLocation: Output<String>? = null, val oauthScopes: Output<List<String>>? = null, val parallelWorkerSettings: Output<WorkerSettingsArgs>? = null, val streamingWorkerMainClass: Output<String>? = null, val taskGroup: Output<String>? = null, val taskUser: Output<String>? = null, val tempStoragePrefix: Output<String>? = null, val vmId: Output<String>? = null, val workflowFileName: Output<String>? = null) : ConvertibleToJava<TaskRunnerSettingsArgs>

Taskrunner configuration settings.

Link copied to clipboard
data class TransformSummaryArgs(val displayData: Output<List<DisplayDataArgs>>? = null, val id: Output<String>? = null, val inputCollectionName: Output<List<String>>? = null, val kind: Output<TransformSummaryKind>? = null, val name: Output<String>? = null, val outputCollectionName: Output<List<String>>? = null) : ConvertibleToJava<TransformSummaryArgs>

Description of the type, names/ids, and input/outputs for a transform.

Link copied to clipboard
data class WorkerPoolArgs(val autoscalingSettings: Output<AutoscalingSettingsArgs>? = null, val dataDisks: Output<List<DiskArgs>>? = null, val defaultPackageSet: Output<WorkerPoolDefaultPackageSet>? = null, val diskSizeGb: Output<Int>? = null, val diskSourceImage: Output<String>? = null, val diskType: Output<String>? = null, val ipConfiguration: Output<WorkerPoolIpConfiguration>? = null, val kind: Output<String>? = null, val machineType: Output<String>? = null, val metadata: Output<Map<String, String>>? = null, val network: Output<String>? = null, val numThreadsPerWorker: Output<Int>? = null, val numWorkers: Output<Int>? = null, val onHostMaintenance: Output<String>? = null, val packages: Output<List<PackageArgs>>? = null, val poolArgs: Output<Map<String, String>>? = null, val sdkHarnessContainerImages: Output<List<SdkHarnessContainerImageArgs>>? = null, val subnetwork: Output<String>? = null, val taskrunnerSettings: Output<TaskRunnerSettingsArgs>? = null, val teardownPolicy: Output<WorkerPoolTeardownPolicy>? = null, val workerHarnessContainerImage: Output<String>, val zone: Output<String>? = null) : ConvertibleToJava<WorkerPoolArgs>

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.

Link copied to clipboard
Link copied to clipboard
data class WorkerSettingsArgs(val baseUrl: Output<String>? = null, val reportingEnabled: Output<Boolean>? = null, val servicePath: Output<String>? = null, val shuffleServicePath: Output<String>? = null, val tempStoragePrefix: Output<String>? = null, val workerId: Output<String>? = null) : ConvertibleToJava<WorkerSettingsArgs>

Provides data to pass through to the worker harness.

Link copied to clipboard