Blame - docs/dyn/dataflow_v1b3.projects.locations.jobs.html - platform/external/python/google-api-python-client

2017-01-06 09:58:29 -0800

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Sai Cheemalapati

4ba8c23

2017-06-06 18:46:08 -0400

[diff] [blame]

78

<code><a href="dataflow_v1b3.projects.locations.jobs.debug.html">debug()</a></code>

79

</p>

80

<p class="firstline">Returns the debug Resource.</p>

81

82

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

83

<code><a href="dataflow_v1b3.projects.locations.jobs.messages.html">messages()</a></code>

84

</p>

85

<p class="firstline">Returns the messages Resource.</p>

86

87

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

88

<code><a href="dataflow_v1b3.projects.locations.jobs.snapshots.html">snapshots()</a></code>

89

</p>

90

<p class="firstline">Returns the snapshots Resource.</p>

91

92

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

93

<code><a href="dataflow_v1b3.projects.locations.jobs.stages.html">stages()</a></code>

94

</p>

95

<p class="firstline">Returns the stages Resource.</p>

96

97

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

98

<code><a href="dataflow_v1b3.projects.locations.jobs.workItems.html">workItems()</a></code>

99

</p>

100

<p class="firstline">Returns the workItems Resource.</p>

101

102

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

103

<code><a href="#close">close()</a></code></p>

104

<p class="firstline">Close httplib2 connections.</p>

105

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

106

<code><a href="#create">create(projectId, location, body=None, view=None, replaceJobId=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

107

<p class="firstline">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`.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

108

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

109

<code><a href="#get">get(projectId, location, jobId, view=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

110

<p class="firstline">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`.</p>

111

112

<code><a href="#getExecutionDetails">getExecutionDetails(projectId, location, jobId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>

113

<p class="firstline">Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.</p>

114

115

<code><a href="#getExecutionDetails_next">getExecutionDetails_next(previous_request, previous_response)</a></code></p>

116

<p class="firstline">Retrieves the next page of results.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

117

118

<code><a href="#getMetrics">getMetrics(projectId, location, jobId, startTime=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

119

<p class="firstline">Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

120

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

121

<code><a href="#list">list(projectId, location, pageSize=None, pageToken=None, view=None, filter=None, x__xgafv=None)</a></code></p>

122

<p class="firstline">List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

123

124

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

125

<p class="firstline">Retrieves the next page of results.</p>

126

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

127

<code><a href="#snapshot">snapshot(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

128

<p class="firstline">Snapshot the state of a streaming job.</p>

129

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

130

<code><a href="#update">update(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

131

<p class="firstline">Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.</p>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

132

<h3>Method Details</h3>

133

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

134

<code class="details" id="close">close()</code>

135

<pre>Close httplib2 connections.</pre>

136

</div>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

137

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

138

139

<code class="details" id="create">create(projectId, location, body=None, view=None, replaceJobId=None, x__xgafv=None)</code>

140

<pre>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`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

141

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

142

Args:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

143

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

144

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

145

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

146

The object takes the form of:

147

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

148

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

149

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

150

{ # A message describing the state of a particular execution stage.

151

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

152

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

153

"executionStageName": "A String", # The name of the execution stage.

154

},

155

],

156

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

157

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

158

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

159

"name": "A String", # User provided name for this transform instance.

160

"displayData": [ # Transform-specific display data.

161

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

162

"durationValue": "A String", # Contains value if the data is of duration type.

163

"javaClassValue": "A String", # Contains value if the data is of java class type.

164

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

165

"boolValue": True or False, # Contains value if the data is of a boolean type.

166

"int64Value": "A String", # Contains value if the data is of int64 type.

167

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

168

"timestampValue": "A String", # Contains value if the data is of timestamp type.

169

"label": "A String", # An optional label to display in a dax UI for the element.

170

"floatValue": 3.14, # Contains value if the data is of float type.

171

"url": "A String", # An optional full URL.

172

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

173

"strValue": "A String", # Contains value if the data is of string type.

174

},

175

],

176

"inputCollectionName": [ # User names for all collection inputs to this transform.

177

"A String",

178

],

179

"id": "A String", # SDK generated id of this transform instance.

180

"kind": "A String", # Type of transform.

181

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

187

{ # 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.

188

"kind": "A String", # Type of tranform this stage is executing.

189

"id": "A String", # Dataflow service generated id for this stage.

190

"name": "A String", # Dataflow service generated name for this stage.

191

"componentTransform": [ # Transforms that comprise this execution stage.

192

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

193

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

194

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

195

"name": "A String", # Dataflow service generated name for this source.

196

},

197

],

198

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

199

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

200

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

201

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

202

"name": "A String", # Dataflow service generated name for this source.

203

},

204

],

205

"outputSource": [ # Output sources for this stage.

206

{ # Description of an input or output of an execution stage.

207

"sizeBytes": "A String", # Size of the source, if measurable.

208

"name": "A String", # Dataflow service generated name for this source.

209

"userName": "A String", # Human-readable name for this source; may be user or system generated.

210

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

211

},

212

],

213

"inputSource": [ # Input sources for this stage.

214

{ # Description of an input or output of an execution stage.

215

"sizeBytes": "A String", # Size of the source, if measurable.

216

"name": "A String", # Dataflow service generated name for this source.

217

"userName": "A String", # Human-readable name for this source; may be user or system generated.

218

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

},

],

},

],

"displayData": [ # Pipeline level display data.

224

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

225

"durationValue": "A String", # Contains value if the data is of duration type.

226

"javaClassValue": "A String", # Contains value if the data is of java class type.

227

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

228

"boolValue": True or False, # Contains value if the data is of a boolean type.

229

"int64Value": "A String", # Contains value if the data is of int64 type.

230

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

231

"timestampValue": "A String", # Contains value if the data is of timestamp type.

232

"label": "A String", # An optional label to display in a dax UI for the element.

233

"floatValue": 3.14, # Contains value if the data is of float type.

234

"url": "A String", # An optional full URL.

235

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

236

"strValue": "A String", # Contains value if the data is of string type.

},

],

},

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

241

"a_key": "A String",

242

},

243

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

244

{ # 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. 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.

245

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

246

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

247

"a_key": "", # Properties of the object.

248

},

249

"kind": "A String", # The kind of step in the Cloud Dataflow job.

250

},

251

],

252

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

253

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

254

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

255

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

256

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

257

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

258

"tempStoragePrefix": "A String", # 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}

259

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

260

"a_key": "", # Properties of the object.

261

},

262

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

263

{ # 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.

264

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

265

"teardownPolicy": "A String", # 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.

266

"metadata": { # Metadata to set on the Google Compute Engine VMs.

267

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

268

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

269

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

270

"poolArgs": { # Extra arguments for this worker pool.

271

"a_key": "", # Properties of the object. Contains field @type with type URL.

272

},

273

"ipConfiguration": "A String", # Configuration for VM IPs.

274

"defaultPackageSet": "A String", # 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.

275

"packages": [ # Packages to be installed on workers.

276

{ # 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.

277

"name": "A String", # The name of the package.

278

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

279

},

280

],

281

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

282

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

283

"languageHint": "A String", # The suggested backend language.

284

"workflowFileName": "A String", # The file to store the workflow in.

285

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

286

"vmId": "A String", # The ID string of the VM.

287

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

288

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

289

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

290

"logUploadLocation": "A String", # 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}

291

"harnessCommand": "A String", # The command to launch the worker harness.

292

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

293

"A String",

294

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

295

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

296

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

297

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

298

"tempStoragePrefix": "A String", # 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}

299

"baseUrl": "A String", # 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/"

300

"logDir": "A String", # The directory on the VM to store logs.

301

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

302

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

303

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

304

"workerId": "A String", # The ID of the worker running this pipeline.

305

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

306

"baseUrl": "A String", # 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/"

307

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

308

"tempStoragePrefix": "A String", # 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}

309

},

310

},

311

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

312

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

313

{ # Defines a SDK harness container for executing Dataflow pipelines.

314

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

315

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

316

},

317

],

318

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

319

"numWorkers": 42, # 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.

320

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

321

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

322

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

323

"algorithm": "A String", # The algorithm to use for autoscaling.

324

},

325

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

326

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

327

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

328

"dataDisks": [ # Data disks that are used by a VM in this workflow.

329

{ # Describes the data disk used by a workflow job.

330

"mountPoint": "A String", # Directory in a VM where disk is mounted.

331

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

332

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

333

},

334

],

335

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

336

"diskSourceImage": "A String", # Fully qualified source image for disks.

337

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

338

},

339

],

340

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

341

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

342

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

343

"userAgent": { # A description of the process that generated the request.

344

"a_key": "", # Properties of the object.

345

},

346

"experiments": [ # The list of experiments to enable.

347

"A String",

348

],

349

"sdkPipelineOptions": { # The Cloud 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.

350

"a_key": "", # Properties of the object.

351

},

352

"internalExperiments": { # Experimental settings.

353

"a_key": "", # Properties of the object. Contains field @type with type URL.

354

},

355

"clusterManagerApiService": "A String", # 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".

356

},

357

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

358

"A String",

359

],

360

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

361

"currentState": "A String", # 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.

362

"currentStateTime": "A String", # The timestamp associated with the current state.

363

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

364

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

365

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

366

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

367

"requestedState": "A String", # 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.

368

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

369

"stages": { # A mapping from each stage to the information about that stage.

370

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

371

"stepName": [ # 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.

"A String",

],

},

},

},

"type": "A String", # The type of Cloud Dataflow job.

378

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

379

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

380

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

381

"a_key": "A String",

382

},

383

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

384

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

385

"fileDetails": [ # Identification of a File source used in the Dataflow job.

386

{ # Metadata for a File connector used by the job.

387

"filePattern": "A String", # File Pattern used to access files by the connector.

388

},

389

],

390

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

391

{ # Metadata for a Spanner connector used by the job.

392

"instanceId": "A String", # InstanceId accessed in the connection.

393

"projectId": "A String", # ProjectId accessed in the connection.

394

"databaseId": "A String", # DatabaseId accessed in the connection.

395

},

396

],

397

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

398

{ # Metadata for a Datastore connector used by the job.

399

"namespace": "A String", # Namespace used in the connection.

400

"projectId": "A String", # ProjectId accessed in the connection.

401

},

402

],

403

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

404

"version": "A String", # The version of the SDK used to run the job.

405

"sdkSupportStatus": "A String", # The support status for this SDK version.

406

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

407

},

408

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

409

{ # Metadata for a PubSub connector used by the job.

410

"subscription": "A String", # Subscription used in the connection.

411

"topic": "A String", # Topic accessed in the connection.

412

},

413

],

414

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

415

{ # Metadata for a BigQuery connector used by the job.

416

"dataset": "A String", # Dataset accessed in the connection.

417

"projectId": "A String", # Project accessed in the connection.

418

"query": "A String", # Query used to access data in the connection.

419

"table": "A String", # Table accessed in the connection.

420

},

421

],

422

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

423

{ # Metadata for a BigTable connector used by the job.

424

"instanceId": "A String", # InstanceId accessed in the connection.

425

"tableId": "A String", # TableId accessed in the connection.

426

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

431

}

432

433

view: string, The level of information requested in response.

434

Allowed values

435

JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

436

JOB_VIEW_SUMMARY - Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.

437

JOB_VIEW_ALL - Request all information available for this job.

438

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

439

replaceJobId: string, Deprecated. This field is now in the Job message.

440

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

447

448

{ # Defines a job to be run by the Cloud Dataflow service.

449

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

450

{ # A message describing the state of a particular execution stage.

451

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

452

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

453

"executionStageName": "A String", # The name of the execution stage.

454

},

455

],

456

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

457

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

458

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

459

"name": "A String", # User provided name for this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

460

"displayData": [ # Transform-specific display data.

461

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

462

"durationValue": "A String", # Contains value if the data is of duration type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

463

"javaClassValue": "A String", # Contains value if the data is of java class type.

464

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

465

"boolValue": True or False, # Contains value if the data is of a boolean type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

466

"int64Value": "A String", # Contains value if the data is of int64 type.

467

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

468

"timestampValue": "A String", # Contains value if the data is of timestamp type.

469

"label": "A String", # An optional label to display in a dax UI for the element.

470

"floatValue": 3.14, # Contains value if the data is of float type.

471

"url": "A String", # An optional full URL.

472

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

473

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

474

},

475

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

476

"inputCollectionName": [ # User names for all collection inputs to this transform.

477

"A String",

478

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

479

"id": "A String", # SDK generated id of this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

480

"kind": "A String", # Type of transform.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

481

"outputCollectionName": [ # User names for all collection outputs to this transform.

482

"A String",

483

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

484

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

485

],

486

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

487

{ # 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.

488

"kind": "A String", # Type of tranform this stage is executing.

489

"id": "A String", # Dataflow service generated id for this stage.

490

"name": "A String", # Dataflow service generated name for this stage.

491

"componentTransform": [ # Transforms that comprise this execution stage.

492

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

493

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

494

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

495

"name": "A String", # Dataflow service generated name for this source.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

496

},

497

],

498

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

499

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

500

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

501

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

502

"name": "A String", # Dataflow service generated name for this source.

503

},

504

],

505

"outputSource": [ # Output sources for this stage.

506

{ # Description of an input or output of an execution stage.

507

"sizeBytes": "A String", # Size of the source, if measurable.

508

"name": "A String", # Dataflow service generated name for this source.

509

"userName": "A String", # Human-readable name for this source; may be user or system generated.

510

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

511

},

512

],

513

"inputSource": [ # Input sources for this stage.

514

{ # Description of an input or output of an execution stage.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

515

"sizeBytes": "A String", # Size of the source, if measurable.

516

"name": "A String", # Dataflow service generated name for this source.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

517

"userName": "A String", # Human-readable name for this source; may be user or system generated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

518

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

519

},

520

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

521

},

522

],

523

"displayData": [ # Pipeline level display data.

524

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

525

"durationValue": "A String", # Contains value if the data is of duration type.

526

"javaClassValue": "A String", # Contains value if the data is of java class type.

527

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

528

"boolValue": True or False, # Contains value if the data is of a boolean type.

529

"int64Value": "A String", # Contains value if the data is of int64 type.

530

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

531

"timestampValue": "A String", # Contains value if the data is of timestamp type.

532

"label": "A String", # An optional label to display in a dax UI for the element.

533

"floatValue": 3.14, # Contains value if the data is of float type.

534

"url": "A String", # An optional full URL.

535

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

536

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

537

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

538

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

540

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

541

"a_key": "A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

542

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

543

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

544

{ # 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. 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.

545

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

546

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

547

"a_key": "", # Properties of the object.

548

},

549

"kind": "A String", # The kind of step in the Cloud Dataflow job.

550

},

551

],

552

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

553

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

554

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

555

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

556

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

557

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

558

"tempStoragePrefix": "A String", # 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}

559

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

560

"a_key": "", # Properties of the object.

561

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

562

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

563

{ # 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.

564

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

565

"teardownPolicy": "A String", # 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

566

"metadata": { # Metadata to set on the Google Compute Engine VMs.

567

"a_key": "A String",

568

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

569

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

570

"poolArgs": { # Extra arguments for this worker pool.

571

"a_key": "", # Properties of the object. Contains field @type with type URL.

572

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

573

"ipConfiguration": "A String", # Configuration for VM IPs.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

574

"defaultPackageSet": "A String", # 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.

575

"packages": [ # Packages to be installed on workers.

576

{ # 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.

577

"name": "A String", # The name of the package.

578

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

579

},

580

],

581

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

582

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

583

"languageHint": "A String", # The suggested backend language.

584

"workflowFileName": "A String", # The file to store the workflow in.

585

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

586

"vmId": "A String", # The ID string of the VM.

587

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

588

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

589

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

590

"logUploadLocation": "A String", # 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}

591

"harnessCommand": "A String", # The command to launch the worker harness.

592

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

593

"A String",

594

],

595

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

596

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

597

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

598

"tempStoragePrefix": "A String", # 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}

599

"baseUrl": "A String", # 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/"

600

"logDir": "A String", # The directory on the VM to store logs.

601

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

602

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

603

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

604

"workerId": "A String", # The ID of the worker running this pipeline.

605

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

606

"baseUrl": "A String", # 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/"

607

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

608

"tempStoragePrefix": "A String", # 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}

609

},

610

},

611

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

612

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

613

{ # Defines a SDK harness container for executing Dataflow pipelines.

614

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

615

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

616

},

617

],

618

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

619

"numWorkers": 42, # 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.

620

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

621

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

622

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

623

"algorithm": "A String", # The algorithm to use for autoscaling.

624

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

625

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

626

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

627

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

628

"dataDisks": [ # Data disks that are used by a VM in this workflow.

629

{ # Describes the data disk used by a workflow job.

630

"mountPoint": "A String", # Directory in a VM where disk is mounted.

631

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

632

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

633

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

634

],

635

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

636

"diskSourceImage": "A String", # Fully qualified source image for disks.

637

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

638

},

639

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

640

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

641

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

642

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

643

"userAgent": { # A description of the process that generated the request.

644

"a_key": "", # Properties of the object.

645

},

646

"experiments": [ # The list of experiments to enable.

647

"A String",

648

],

649

"sdkPipelineOptions": { # The Cloud 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.

650

"a_key": "", # Properties of the object.

651

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

652

"internalExperiments": { # Experimental settings.

653

"a_key": "", # Properties of the object. Contains field @type with type URL.

654

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

655

"clusterManagerApiService": "A String", # 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".

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

656

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

657

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

658

"A String",

659

],

660

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

661

"currentState": "A String", # 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.

662

"currentStateTime": "A String", # The timestamp associated with the current state.

663

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

664

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

665

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

666

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

667

"requestedState": "A String", # 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.

668

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

669

"stages": { # A mapping from each stage to the information about that stage.

670

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

671

"stepName": [ # 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.

672

"A String",

673

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

674

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

675

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

676

},

677

"type": "A String", # The type of Cloud Dataflow job.

678

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

679

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

680

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

681

"a_key": "A String",

682

},

683

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

684

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

685

"fileDetails": [ # Identification of a File source used in the Dataflow job.

686

{ # Metadata for a File connector used by the job.

687

"filePattern": "A String", # File Pattern used to access files by the connector.

688

},

689

],

690

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

691

{ # Metadata for a Spanner connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

692

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

693

"projectId": "A String", # ProjectId accessed in the connection.

694

"databaseId": "A String", # DatabaseId accessed in the connection.

695

},

696

],

697

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

698

{ # Metadata for a Datastore connector used by the job.

699

"namespace": "A String", # Namespace used in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

700

"projectId": "A String", # ProjectId accessed in the connection.

701

},

702

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

703

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

704

"version": "A String", # The version of the SDK used to run the job.

705

"sdkSupportStatus": "A String", # The support status for this SDK version.

706

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

707

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

708

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

709

{ # Metadata for a PubSub connector used by the job.

710

"subscription": "A String", # Subscription used in the connection.

711

"topic": "A String", # Topic accessed in the connection.

712

},

713

],

714

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

715

{ # Metadata for a BigQuery connector used by the job.

716

"dataset": "A String", # Dataset accessed in the connection.

717

"projectId": "A String", # Project accessed in the connection.

718

"query": "A String", # Query used to access data in the connection.

719

"table": "A String", # Table accessed in the connection.

720

},

721

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

722

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

723

{ # Metadata for a BigTable connector used by the job.

724

"instanceId": "A String", # InstanceId accessed in the connection.

725

"tableId": "A String", # TableId accessed in the connection.

726

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

}</pre>

</div>

<code class="details" id="get">get(projectId, location, jobId, view=None, x__xgafv=None)</code>

736

<pre>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`.

737

738

Args:

739

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

740

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

741

jobId: string, The job ID. (required)

742

view: string, The level of information requested in response.

743

Allowed values

744

JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

745

JOB_VIEW_SUMMARY - Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.

746

JOB_VIEW_ALL - Request all information available for this job.

747

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

748

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

755

756

{ # Defines a job to be run by the Cloud Dataflow service.

757

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

758

{ # A message describing the state of a particular execution stage.

759

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

760

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

761

"executionStageName": "A String", # The name of the execution stage.

762

},

763

],

764

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

765

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

766

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

767

"name": "A String", # User provided name for this transform instance.

768

"displayData": [ # Transform-specific display data.

769

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

770

"durationValue": "A String", # Contains value if the data is of duration type.

771

"javaClassValue": "A String", # Contains value if the data is of java class type.

772

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

773

"boolValue": True or False, # Contains value if the data is of a boolean type.

774

"int64Value": "A String", # Contains value if the data is of int64 type.

775

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

776

"timestampValue": "A String", # Contains value if the data is of timestamp type.

777

"label": "A String", # An optional label to display in a dax UI for the element.

778

"floatValue": 3.14, # Contains value if the data is of float type.

779

"url": "A String", # An optional full URL.

780

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

781

"strValue": "A String", # Contains value if the data is of string type.

782

},

783

],

784

"inputCollectionName": [ # User names for all collection inputs to this transform.

785

"A String",

786

],

787

"id": "A String", # SDK generated id of this transform instance.

788

"kind": "A String", # Type of transform.

789

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

795

{ # 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.

796

"kind": "A String", # Type of tranform this stage is executing.

797

"id": "A String", # Dataflow service generated id for this stage.

798

"name": "A String", # Dataflow service generated name for this stage.

799

"componentTransform": [ # Transforms that comprise this execution stage.

800

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

801

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

802

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

803

"name": "A String", # Dataflow service generated name for this source.

804

},

805

],

806

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

807

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

808

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

809

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

810

"name": "A String", # Dataflow service generated name for this source.

811

},

812

],

813

"outputSource": [ # Output sources for this stage.

814

{ # Description of an input or output of an execution stage.

815

"sizeBytes": "A String", # Size of the source, if measurable.

816

"name": "A String", # Dataflow service generated name for this source.

817

"userName": "A String", # Human-readable name for this source; may be user or system generated.

818

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

819

},

820

],

821

"inputSource": [ # Input sources for this stage.

822

{ # Description of an input or output of an execution stage.

823

"sizeBytes": "A String", # Size of the source, if measurable.

824

"name": "A String", # Dataflow service generated name for this source.

825

"userName": "A String", # Human-readable name for this source; may be user or system generated.

826

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

},

],

},

],

"displayData": [ # Pipeline level display data.

832

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

833

"durationValue": "A String", # Contains value if the data is of duration type.

834

"javaClassValue": "A String", # Contains value if the data is of java class type.

835

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

836

"boolValue": True or False, # Contains value if the data is of a boolean type.

837

"int64Value": "A String", # Contains value if the data is of int64 type.

838

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

839

"timestampValue": "A String", # Contains value if the data is of timestamp type.

840

"label": "A String", # An optional label to display in a dax UI for the element.

841

"floatValue": 3.14, # Contains value if the data is of float type.

842

"url": "A String", # An optional full URL.

843

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

844

"strValue": "A String", # Contains value if the data is of string type.

},

],

},

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

849

"a_key": "A String",

850

},

851

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

852

{ # 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. 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.

853

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

854

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

855

"a_key": "", # Properties of the object.

856

},

857

"kind": "A String", # The kind of step in the Cloud Dataflow job.

858

},

859

],

860

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

861

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

862

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

863

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

864

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

865

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

866

"tempStoragePrefix": "A String", # 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}

867

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

868

"a_key": "", # Properties of the object.

869

},

870

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

871

{ # 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.

872

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

873

"teardownPolicy": "A String", # 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.

874

"metadata": { # Metadata to set on the Google Compute Engine VMs.

875

"a_key": "A String",

876

},

877

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

878

"poolArgs": { # Extra arguments for this worker pool.

879

"a_key": "", # Properties of the object. Contains field @type with type URL.

880

},

881

"ipConfiguration": "A String", # Configuration for VM IPs.

882

"defaultPackageSet": "A String", # 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.

883

"packages": [ # Packages to be installed on workers.

884

{ # 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.

885

"name": "A String", # The name of the package.

886

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

887

},

888

],

889

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

890

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

891

"languageHint": "A String", # The suggested backend language.

892

"workflowFileName": "A String", # The file to store the workflow in.

893

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

894

"vmId": "A String", # The ID string of the VM.

895

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

896

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

897

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

898

"logUploadLocation": "A String", # 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}

899

"harnessCommand": "A String", # The command to launch the worker harness.

900

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

901

"A String",

902

],

903

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

904

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

905

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

906

"tempStoragePrefix": "A String", # 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}

907

"baseUrl": "A String", # 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/"

908

"logDir": "A String", # The directory on the VM to store logs.

909

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

910

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

911

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

912

"workerId": "A String", # The ID of the worker running this pipeline.

913

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

914

"baseUrl": "A String", # 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/"

915

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

916

"tempStoragePrefix": "A String", # 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}

917

},

918

},

919

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

920

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

921

{ # Defines a SDK harness container for executing Dataflow pipelines.

922

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

923

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

924

},

925

],

926

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

927

"numWorkers": 42, # 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.

928

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

929

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

930

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

931

"algorithm": "A String", # The algorithm to use for autoscaling.

932

},

933

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

934

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

935

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

936

"dataDisks": [ # Data disks that are used by a VM in this workflow.

937

{ # Describes the data disk used by a workflow job.

938

"mountPoint": "A String", # Directory in a VM where disk is mounted.

939

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

940

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

941

},

942

],

943

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

944

"diskSourceImage": "A String", # Fully qualified source image for disks.

945

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

946

},

947

],

948

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

949

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

950

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

951

"userAgent": { # A description of the process that generated the request.

952

"a_key": "", # Properties of the object.

953

},

954

"experiments": [ # The list of experiments to enable.

955

"A String",

956

],

957

"sdkPipelineOptions": { # The Cloud 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.

958

"a_key": "", # Properties of the object.

959

},

960

"internalExperiments": { # Experimental settings.

961

"a_key": "", # Properties of the object. Contains field @type with type URL.

962

},

963

"clusterManagerApiService": "A String", # 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".

964

},

965

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

966

"A String",

967

],

968

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

969

"currentState": "A String", # 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.

970

"currentStateTime": "A String", # The timestamp associated with the current state.

971

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

972

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

973

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

974

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

975

"requestedState": "A String", # 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.

976

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

977

"stages": { # A mapping from each stage to the information about that stage.

978

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

979

"stepName": [ # 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.

"A String",

],

},

},

},

"type": "A String", # The type of Cloud Dataflow job.

986

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

987

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

988

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

989

"a_key": "A String",

990

},

991

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

992

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

993

"fileDetails": [ # Identification of a File source used in the Dataflow job.

994

{ # Metadata for a File connector used by the job.

995

"filePattern": "A String", # File Pattern used to access files by the connector.

996

},

997

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

998

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

999

{ # Metadata for a Spanner connector used by the job.

1000

"instanceId": "A String", # InstanceId accessed in the connection.

1001

"projectId": "A String", # ProjectId accessed in the connection.

1002

"databaseId": "A String", # DatabaseId accessed in the connection.

1003

},

1004

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1005

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1006

{ # Metadata for a Datastore connector used by the job.

1007

"namespace": "A String", # Namespace used in the connection.

1008

"projectId": "A String", # ProjectId accessed in the connection.

1009

},

1010

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1011

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1012

"version": "A String", # The version of the SDK used to run the job.

1013

"sdkSupportStatus": "A String", # The support status for this SDK version.

1014

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1015

},

1016

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1017

{ # Metadata for a PubSub connector used by the job.

1018

"subscription": "A String", # Subscription used in the connection.

1019

"topic": "A String", # Topic accessed in the connection.

1020

},

1021

],

1022

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1023

{ # Metadata for a BigQuery connector used by the job.

1024

"dataset": "A String", # Dataset accessed in the connection.

1025

"projectId": "A String", # Project accessed in the connection.

1026

"query": "A String", # Query used to access data in the connection.

1027

"table": "A String", # Table accessed in the connection.

1028

},

1029

],

1030

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1031

{ # Metadata for a BigTable connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1032

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1033

"tableId": "A String", # TableId accessed in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1034

"projectId": "A String", # ProjectId accessed in the connection.

1035

},

1036

],

1037

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1038

"stepsLocation": "A String", # The GCS location where the steps are stored.

1039

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1043

<code class="details" id="getExecutionDetails">getExecutionDetails(projectId, location, jobId, pageSize=None, pageToken=None, x__xgafv=None)</code>

1044

<pre>Request detailed information about the execution status of the job. EXPERIMENTAL. This API is subject to change or removal without notice.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1045

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1046

Args:

1047

projectId: string, A project id. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1048

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)

1049

jobId: string, The job to get execution details for. (required)

1050

pageSize: integer, If specified, determines the maximum number of stages to return. If unspecified, the service may choose an appropriate default, or may return an arbitrarily large number of results.

1051

pageToken: string, If supplied, this should be the value of next_page_token returned by an earlier call. This will cause the next page of results to be returned.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1052

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1053

Allowed values

1054

1 - v1 error format

1055

2 - v2 error format

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1056

1057

Returns:

1058

An object of the form:

1059

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1060

{ # Information about the execution of a job.

1061

"nextPageToken": "A String", # If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value.

1062

"stages": [ # The stages of the job execution.

1063

{ # Information about a particular execution stage of a job.

1064

"progress": { # Information about the progress of some component of job execution. # Progress for this stage. Only applicable to Batch jobs.

1065

"currentProgress": 3.14, # The current progress of the component, in the range [0,1].

1066

"dataPoints": [ # History of progress for the component. Points are sorted by time.

1067

{ # A point in the timeseries.

1068

"value": 3.14, # The value of the point.

1069

"time": "A String", # The timestamp of the point.

1070

},

1071

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1072

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1073

"metrics": [ # Metrics for this stage.

1074

{ # Describes the state of a metric.

1075

"meanSum": "", # 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.

1076

"meanCount": "", # 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.

1077

"kind": "A String", # Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

1078

"name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.

1079

"name": "A String", # Worker-defined metric name.

1080

"context": { # 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'] = .

1081

"a_key": "A String",

1082

},

1083

"origin": "A String", # Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.

1084

},

1085

"set": "", # 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.

1086

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1087

"distribution": "", # A struct value describing properties of a distribution of numeric values.

1088

"updateTime": "A String", # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

1089

"gauge": "", # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

1090

"cumulative": True or False, # 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.

1091

"scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

1092

},

1093

],

1094

"endTime": "A String", # End time of this stage. If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

1095

"startTime": "A String", # Start time of this stage.

1096

"state": "A String", # State of this stage.

1097

"stageId": "A String", # ID of this stage

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1098

},

1099

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1104

<code class="details" id="getExecutionDetails_next">getExecutionDetails_next(previous_request, previous_response)</code>

1105

<pre>Retrieves the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1106

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1107

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1108

previous_request: The request for the previous page. (required)

1109

previous_response: The response from the request for the previous page. (required)

1110

1111

Returns:

1112

A request object that you can call 'execute()' on to request the next

1113

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="getMetrics">getMetrics(projectId, location, jobId, startTime=None, x__xgafv=None)</code>

1119

<pre>Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`.

1120

1121

Args:

1122

projectId: string, A project id. (required)

1123

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)

1124

jobId: string, The job to get metrics for. (required)

1125

startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1126

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1127

Allowed values

1128

1 - v1 error format

1129

2 - v2 error format

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1130

1131

Returns:

1132

An object of the form:

1133

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1134

{ # JobMetrics contains a collection of metrics describing 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.

1135

"metrics": [ # All metrics for this job.

1136

{ # Describes the state of a metric.

1137

"meanSum": "", # 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.

1138

"meanCount": "", # 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.

1139

"kind": "A String", # Metric aggregation kind. The possible metric aggregation kinds are "Sum", "Max", "Min", "Mean", "Set", "And", "Or", and "Distribution". The specified aggregation kind is case-insensitive. If omitted, this is not an aggregated value but instead a single metric sample value.

1140

"name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.

1141

"name": "A String", # Worker-defined metric name.

1142

"context": { # 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'] = .

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1143

"a_key": "A String",

1144

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1145

"origin": "A String", # Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1146

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1147

"set": "", # 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.

1148

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1149

"distribution": "", # A struct value describing properties of a distribution of numeric values.

1150

"updateTime": "A String", # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

1151

"gauge": "", # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

1152

"cumulative": True or False, # 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.

1153

"scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1154

},

1155

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1156

"metricTime": "A String", # Timestamp as of which metric values are current.

}</pre>

</div>

<code class="details" id="list">list(projectId, location, pageSize=None, pageToken=None, view=None, filter=None, x__xgafv=None)</code>

1162

<pre>List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.

1163

1164

Args:

1165

projectId: string, The project which owns the jobs. (required)

1166

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

1167

pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit.

1168

pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

1169

view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.

1170

Allowed values

1171

JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information.

1172

JOB_VIEW_SUMMARY - Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details.

1173

JOB_VIEW_ALL - Request all information available for this job.

1174

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

1175

filter: string, The kind of filter to use.

1176

Allowed values

1177

UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`.

1178

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.

1179

TERMINATED - Filters the jobs that have a terminated state, ordered on the termination timestamp. Example terminated states: `JOB_STATE_STOPPED`, `JOB_STATE_UPDATED`, `JOB_STATE_DRAINED`, etc.

1180

ACTIVE - Filters the jobs that are running ordered on the creation timestamp.

1181

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1188

1189

{ # Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}.

1190

"jobs": [ # A subset of the requested job information.

1191

{ # Defines a job to be run by the Cloud Dataflow service.

1192

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1193

{ # A message describing the state of a particular execution stage.

1194

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1195

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1196

"executionStageName": "A String", # The name of the execution stage.

1197

},

1198

],

1199

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

1200

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1201

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

1202

"name": "A String", # User provided name for this transform instance.

1203

"displayData": [ # Transform-specific display data.

1204

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

1205

"durationValue": "A String", # Contains value if the data is of duration type.

1206

"javaClassValue": "A String", # Contains value if the data is of java class type.

1207

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

1208

"boolValue": True or False, # Contains value if the data is of a boolean type.

1209

"int64Value": "A String", # Contains value if the data is of int64 type.

1210

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1211

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1212

"label": "A String", # An optional label to display in a dax UI for the element.

1213

"floatValue": 3.14, # Contains value if the data is of float type.

1214

"url": "A String", # An optional full URL.

1215

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1216

"strValue": "A String", # Contains value if the data is of string type.

1217

},

1218

],

1219

"inputCollectionName": [ # User names for all collection inputs to this transform.

1220

"A String",

1221

],

1222

"id": "A String", # SDK generated id of this transform instance.

1223

"kind": "A String", # Type of transform.

1224

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1230

{ # 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.

1231

"kind": "A String", # Type of tranform this stage is executing.

1232

"id": "A String", # Dataflow service generated id for this stage.

1233

"name": "A String", # Dataflow service generated name for this stage.

1234

"componentTransform": [ # Transforms that comprise this execution stage.

1235

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

1236

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1237

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1238

"name": "A String", # Dataflow service generated name for this source.

1239

},

1240

],

1241

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1242

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

1243

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1244

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1245

"name": "A String", # Dataflow service generated name for this source.

1246

},

1247

],

1248

"outputSource": [ # Output sources for this stage.

1249

{ # Description of an input or output of an execution stage.

1250

"sizeBytes": "A String", # Size of the source, if measurable.

1251

"name": "A String", # Dataflow service generated name for this source.

1252

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1253

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1254

},

1255

],

1256

"inputSource": [ # Input sources for this stage.

1257

{ # Description of an input or output of an execution stage.

1258

"sizeBytes": "A String", # Size of the source, if measurable.

1259

"name": "A String", # Dataflow service generated name for this source.

1260

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1261

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

},

],

},

],

"displayData": [ # Pipeline level display data.

1267

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

1268

"durationValue": "A String", # Contains value if the data is of duration type.

1269

"javaClassValue": "A String", # Contains value if the data is of java class type.

1270

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

1271

"boolValue": True or False, # Contains value if the data is of a boolean type.

1272

"int64Value": "A String", # Contains value if the data is of int64 type.

1273

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1274

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1275

"label": "A String", # An optional label to display in a dax UI for the element.

1276

"floatValue": 3.14, # Contains value if the data is of float type.

1277

"url": "A String", # An optional full URL.

1278

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1279

"strValue": "A String", # Contains value if the data is of string type.

},

],

},

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

1284

"a_key": "A String",

1285

},

1286

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

1287

{ # 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. 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.

1288

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

1289

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

1290

"a_key": "", # Properties of the object.

1291

},

1292

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1293

},

1294

],

1295

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

1296

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

1297

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1298

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

1299

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

1300

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

1301

"tempStoragePrefix": "A String", # 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}

1302

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1303

"a_key": "", # Properties of the object.

1304

},

1305

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1306

{ # 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.

1307

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1308

"teardownPolicy": "A String", # 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.

1309

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1310

"a_key": "A String",

1311

},

1312

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1313

"poolArgs": { # Extra arguments for this worker pool.

1314

"a_key": "", # Properties of the object. Contains field @type with type URL.

1315

},

1316

"ipConfiguration": "A String", # Configuration for VM IPs.

1317

"defaultPackageSet": "A String", # 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.

1318

"packages": [ # Packages to be installed on workers.

1319

{ # 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.

1320

"name": "A String", # The name of the package.

1321

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

1322

},

1323

],

1324

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1325

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1326

"languageHint": "A String", # The suggested backend language.

1327

"workflowFileName": "A String", # The file to store the workflow in.

1328

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1329

"vmId": "A String", # The ID string of the VM.

1330

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1331

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1332

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1333

"logUploadLocation": "A String", # 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}

1334

"harnessCommand": "A String", # The command to launch the worker harness.

1335

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1336

"A String",

1337

],

1338

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1339

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1340

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1341

"tempStoragePrefix": "A String", # 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}

1342

"baseUrl": "A String", # 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/"

1343

"logDir": "A String", # The directory on the VM to store logs.

1344

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1345

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1346

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1347

"workerId": "A String", # The ID of the worker running this pipeline.

1348

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1349

"baseUrl": "A String", # 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/"

1350

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1351

"tempStoragePrefix": "A String", # 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}

1352

},

1353

},

1354

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1355

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

1356

{ # Defines a SDK harness container for executing Dataflow pipelines.

1357

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1358

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

1359

},

1360

],

1361

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1362

"numWorkers": 42, # 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.

1363

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1364

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1365

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1366

"algorithm": "A String", # The algorithm to use for autoscaling.

1367

},

1368

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1369

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

1370

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

1371

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1372

{ # Describes the data disk used by a workflow job.

1373

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1374

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

1375

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

1376

},

1377

],

1378

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1379

"diskSourceImage": "A String", # Fully qualified source image for disks.

1380

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

1381

},

1382

],

1383

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

1384

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1385

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1386

"userAgent": { # A description of the process that generated the request.

1387

"a_key": "", # Properties of the object.

1388

},

1389

"experiments": [ # The list of experiments to enable.

1390

"A String",

1391

],

1392

"sdkPipelineOptions": { # The Cloud 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.

1393

"a_key": "", # Properties of the object.

1394

},

1395

"internalExperiments": { # Experimental settings.

1396

"a_key": "", # Properties of the object. Contains field @type with type URL.

1397

},

1398

"clusterManagerApiService": "A String", # 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".

1399

},

1400

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

1401

"A String",

1402

],

1403

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

1404

"currentState": "A String", # 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.

1405

"currentStateTime": "A String", # The timestamp associated with the current state.

1406

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

1407

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1408

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

1409

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1410

"requestedState": "A String", # 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.

1411

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1412

"stages": { # A mapping from each stage to the information about that stage.

1413

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1414

"stepName": [ # 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.

"A String",

],

},

},

},

"type": "A String", # The type of Cloud Dataflow job.

1421

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

1422

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1423

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1424

"a_key": "A String",

1425

},

1426

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

1427

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

1428

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1429

{ # Metadata for a File connector used by the job.

1430

"filePattern": "A String", # File Pattern used to access files by the connector.

1431

},

1432

],

1433

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1434

{ # Metadata for a Spanner connector used by the job.

1435

"instanceId": "A String", # InstanceId accessed in the connection.

1436

"projectId": "A String", # ProjectId accessed in the connection.

1437

"databaseId": "A String", # DatabaseId accessed in the connection.

1438

},

1439

],

1440

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1441

{ # Metadata for a Datastore connector used by the job.

1442

"namespace": "A String", # Namespace used in the connection.

1443

"projectId": "A String", # ProjectId accessed in the connection.

1444

},

1445

],

1446

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1447

"version": "A String", # The version of the SDK used to run the job.

1448

"sdkSupportStatus": "A String", # The support status for this SDK version.

1449

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1450

},

1451

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1452

{ # Metadata for a PubSub connector used by the job.

1453

"subscription": "A String", # Subscription used in the connection.

1454

"topic": "A String", # Topic accessed in the connection.

1455

},

1456

],

1457

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1458

{ # Metadata for a BigQuery connector used by the job.

1459

"dataset": "A String", # Dataset accessed in the connection.

1460

"projectId": "A String", # Project accessed in the connection.

1461

"query": "A String", # Query used to access data in the connection.

1462

"table": "A String", # Table accessed in the connection.

1463

},

1464

],

1465

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1466

{ # Metadata for a BigTable connector used by the job.

1467

"instanceId": "A String", # InstanceId accessed in the connection.

1468

"tableId": "A String", # TableId accessed in the connection.

1469

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

1474

},

1475

],

1476

"failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1477

{ # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

1478

"name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1479

},

1480

],

1481

"nextPageToken": "A String", # Set if there may be more results than fit in this response.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1487

<pre>Retrieves the next page of results.

1488

1489

Args:

1490

previous_request: The request for the previous page. (required)

1491

previous_response: The response from the request for the previous page. (required)

1492

1493

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1494

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1495

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1500

<code class="details" id="snapshot">snapshot(projectId, location, jobId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1501

<pre>Snapshot the state of a streaming job.

1502

1503

Args:

1504

projectId: string, The project which owns the job to be snapshotted. (required)

1505

location: string, The location that contains this job. (required)

1506

jobId: string, The job to be snapshotted. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1507

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1508

The object takes the form of:

1509

1510

{ # Request to create a snapshot of a job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1511

"ttl": "A String", # TTL for the snapshot.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1512

"snapshotSources": True or False, # If true, perform snapshots for sources which support this.

1513

"description": "A String", # User specified description of the snapshot. Maybe empty.

1514

"location": "A String", # The location that contains this job.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1515

}

1516

1517

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1524

1525

{ # Represents a snapshot of a job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1526

"projectId": "A String", # The project this snapshot belongs to.

1527

"diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY state.

1528

"creationTime": "A String", # The time this snapshot was created.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1529

"ttl": "A String", # The time after which this snapshot will be automatically deleted.

1530

"state": "A String", # State of the snapshot.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1531

"sourceJobId": "A String", # The job this snapshot was created from.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1532

"description": "A String", # User specified description of the snapshot. Maybe empty.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1533

"id": "A String", # The unique ID of this snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1534

"pubsubMetadata": [ # PubSub snapshot metadata.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1535

{ # Represents a Pubsub snapshot.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1536

"expireTime": "A String", # The expire time of the Pubsub snapshot.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1537

"topicName": "A String", # The name of the Pubsub topic.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1538

"snapshotName": "A String", # The name of the Pubsub snapshot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1539

},

1540

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1545

<code class="details" id="update">update(projectId, location, jobId, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1546

<pre>Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1547

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1548

Args:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1549

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1550

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1551

jobId: string, The job ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1552

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1553

The object takes the form of:

1554

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1555

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1556

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1557

{ # A message describing the state of a particular execution stage.

1558

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1559

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1560

"executionStageName": "A String", # The name of the execution stage.

1561

},

1562

],

1563

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

1564

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1565

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

1566

"name": "A String", # User provided name for this transform instance.

1567

"displayData": [ # Transform-specific display data.

1568

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

1569

"durationValue": "A String", # Contains value if the data is of duration type.

1570

"javaClassValue": "A String", # Contains value if the data is of java class type.

1571

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

1572

"boolValue": True or False, # Contains value if the data is of a boolean type.

1573

"int64Value": "A String", # Contains value if the data is of int64 type.

1574

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1575

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1576

"label": "A String", # An optional label to display in a dax UI for the element.

1577

"floatValue": 3.14, # Contains value if the data is of float type.

1578

"url": "A String", # An optional full URL.

1579

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1580

"strValue": "A String", # Contains value if the data is of string type.

1581

},

1582

],

1583

"inputCollectionName": [ # User names for all collection inputs to this transform.

1584

"A String",

1585

],

1586

"id": "A String", # SDK generated id of this transform instance.

1587

"kind": "A String", # Type of transform.

1588

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1594

{ # 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.

1595

"kind": "A String", # Type of tranform this stage is executing.

1596

"id": "A String", # Dataflow service generated id for this stage.

1597

"name": "A String", # Dataflow service generated name for this stage.

1598

"componentTransform": [ # Transforms that comprise this execution stage.

1599

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

1600

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1601

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1602

"name": "A String", # Dataflow service generated name for this source.

1603

},

1604

],

1605

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1606

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

1607

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1608

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1609

"name": "A String", # Dataflow service generated name for this source.

1610

},

1611

],

1612

"outputSource": [ # Output sources for this stage.

1613

{ # Description of an input or output of an execution stage.

1614

"sizeBytes": "A String", # Size of the source, if measurable.

1615

"name": "A String", # Dataflow service generated name for this source.

1616

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1617

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1618

},

1619

],

1620

"inputSource": [ # Input sources for this stage.

1621

{ # Description of an input or output of an execution stage.

1622

"sizeBytes": "A String", # Size of the source, if measurable.

1623

"name": "A String", # Dataflow service generated name for this source.

1624

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1625

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

},

],

},

],

"displayData": [ # Pipeline level display data.

1631

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

1632

"durationValue": "A String", # Contains value if the data is of duration type.

1633

"javaClassValue": "A String", # Contains value if the data is of java class type.

1634

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

1635

"boolValue": True or False, # Contains value if the data is of a boolean type.

1636

"int64Value": "A String", # Contains value if the data is of int64 type.

1637

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1638

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1639

"label": "A String", # An optional label to display in a dax UI for the element.

1640

"floatValue": 3.14, # Contains value if the data is of float type.

1641

"url": "A String", # An optional full URL.

1642

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1643

"strValue": "A String", # Contains value if the data is of string type.

},

],

},

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

1648

"a_key": "A String",

1649

},

1650

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

1651

{ # 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. 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.

1652

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

1653

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

1654

"a_key": "", # Properties of the object.

1655

},

1656

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1657

},

1658

],

1659

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

1660

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

1661

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1662

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

1663

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

1664

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

1665

"tempStoragePrefix": "A String", # 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}

1666

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1667

"a_key": "", # Properties of the object.

1668

},

1669

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1670

{ # 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.

1671

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1672

"teardownPolicy": "A String", # 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.

1673

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1674

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1675

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1676

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1677

"poolArgs": { # Extra arguments for this worker pool.

1678

"a_key": "", # Properties of the object. Contains field @type with type URL.

1679

},

1680

"ipConfiguration": "A String", # Configuration for VM IPs.

1681

"defaultPackageSet": "A String", # 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.

1682

"packages": [ # Packages to be installed on workers.

1683

{ # 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.

1684

"name": "A String", # The name of the package.

1685

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

1686

},

1687

],

1688

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1689

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1690

"languageHint": "A String", # The suggested backend language.

1691

"workflowFileName": "A String", # The file to store the workflow in.

1692

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1693

"vmId": "A String", # The ID string of the VM.

1694

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1695

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1696

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1697

"logUploadLocation": "A String", # 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}

1698

"harnessCommand": "A String", # The command to launch the worker harness.

1699

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1700

"A String",

1701

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1702

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1703

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1704

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1705

"tempStoragePrefix": "A String", # 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}

1706

"baseUrl": "A String", # 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/"

1707

"logDir": "A String", # The directory on the VM to store logs.

1708

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1709

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1710

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1711

"workerId": "A String", # The ID of the worker running this pipeline.

1712

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1713

"baseUrl": "A String", # 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/"

1714

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1715

"tempStoragePrefix": "A String", # 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}

1716

},

1717

},

1718

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1719

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

1720

{ # Defines a SDK harness container for executing Dataflow pipelines.

1721

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1722

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

1723

},

1724

],

1725

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1726

"numWorkers": 42, # 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.

1727

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1728

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1729

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1730

"algorithm": "A String", # The algorithm to use for autoscaling.

1731

},

1732

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1733

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

1734

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

1735

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1736

{ # Describes the data disk used by a workflow job.

1737

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1738

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

1739

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

1740

},

1741

],

1742

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1743

"diskSourceImage": "A String", # Fully qualified source image for disks.

1744

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

1745

},

1746

],

1747

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

1748

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1749

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1750

"userAgent": { # A description of the process that generated the request.

1751

"a_key": "", # Properties of the object.

1752

},

1753

"experiments": [ # The list of experiments to enable.

1754

"A String",

1755

],

1756

"sdkPipelineOptions": { # The Cloud 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.

1757

"a_key": "", # Properties of the object.

1758

},

1759

"internalExperiments": { # Experimental settings.

1760

"a_key": "", # Properties of the object. Contains field @type with type URL.

1761

},

1762

"clusterManagerApiService": "A String", # 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".

1763

},

1764

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

1765

"A String",

1766

],

1767

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

1768

"currentState": "A String", # 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.

1769

"currentStateTime": "A String", # The timestamp associated with the current state.

1770

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

1771

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1772

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

1773

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1774

"requestedState": "A String", # 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.

1775

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1776

"stages": { # A mapping from each stage to the information about that stage.

1777

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1778

"stepName": [ # 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.

"A String",

],

},

},

},

"type": "A String", # The type of Cloud Dataflow job.

1785

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

1786

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1787

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1788

"a_key": "A String",

1789

},

1790

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

1791

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

1792

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1793

{ # Metadata for a File connector used by the job.

1794

"filePattern": "A String", # File Pattern used to access files by the connector.

1795

},

1796

],

1797

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1798

{ # Metadata for a Spanner connector used by the job.

1799

"instanceId": "A String", # InstanceId accessed in the connection.

1800

"projectId": "A String", # ProjectId accessed in the connection.

1801

"databaseId": "A String", # DatabaseId accessed in the connection.

1802

},

1803

],

1804

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1805

{ # Metadata for a Datastore connector used by the job.

1806

"namespace": "A String", # Namespace used in the connection.

1807

"projectId": "A String", # ProjectId accessed in the connection.

1808

},

1809

],

1810

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1811

"version": "A String", # The version of the SDK used to run the job.

1812

"sdkSupportStatus": "A String", # The support status for this SDK version.

1813

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1814

},

1815

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1816

{ # Metadata for a PubSub connector used by the job.

1817

"subscription": "A String", # Subscription used in the connection.

1818

"topic": "A String", # Topic accessed in the connection.

1819

},

1820

],

1821

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1822

{ # Metadata for a BigQuery connector used by the job.

1823

"dataset": "A String", # Dataset accessed in the connection.

1824

"projectId": "A String", # Project accessed in the connection.

1825

"query": "A String", # Query used to access data in the connection.

1826

"table": "A String", # Table accessed in the connection.

1827

},

1828

],

1829

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1830

{ # Metadata for a BigTable connector used by the job.

1831

"instanceId": "A String", # InstanceId accessed in the connection.

1832

"tableId": "A String", # TableId accessed in the connection.

1833

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

1838

}

1839

1840

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1847

1848

{ # Defines a job to be run by the Cloud Dataflow service.

1849

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1850

{ # A message describing the state of a particular execution stage.

1851

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1852

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1853

"executionStageName": "A String", # The name of the execution stage.

1854

},

1855

],

1856

"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. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.

1857

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1858

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

1859

"name": "A String", # User provided name for this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1860

"displayData": [ # Transform-specific display data.

1861

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1862

"durationValue": "A String", # Contains value if the data is of duration type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1863

"javaClassValue": "A String", # Contains value if the data is of java class type.

1864

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1865

"boolValue": True or False, # Contains value if the data is of a boolean type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1866

"int64Value": "A String", # Contains value if the data is of int64 type.

1867

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1868

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1869

"label": "A String", # An optional label to display in a dax UI for the element.

1870

"floatValue": 3.14, # Contains value if the data is of float type.

1871

"url": "A String", # An optional full URL.

1872

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1873

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1874

},

1875

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1876

"inputCollectionName": [ # User names for all collection inputs to this transform.

1877

"A String",

1878

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1879

"id": "A String", # SDK generated id of this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1880

"kind": "A String", # Type of transform.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1881

"outputCollectionName": [ # User names for all collection outputs to this transform.

1882

"A String",

1883

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1884

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1885

],

1886

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1887

{ # 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.

1888

"kind": "A String", # Type of tranform this stage is executing.

1889

"id": "A String", # Dataflow service generated id for this stage.

1890

"name": "A String", # Dataflow service generated name for this stage.

1891

"componentTransform": [ # Transforms that comprise this execution stage.

1892

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1893

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1894

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1895

"name": "A String", # Dataflow service generated name for this source.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1896

},

1897

],

1898

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1899

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

1900

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1901

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1902

"name": "A String", # Dataflow service generated name for this source.

1903

},

1904

],

1905

"outputSource": [ # Output sources for this stage.

1906

{ # Description of an input or output of an execution stage.

1907

"sizeBytes": "A String", # Size of the source, if measurable.

1908

"name": "A String", # Dataflow service generated name for this source.

1909

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1910

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1911

},

1912

],

1913

"inputSource": [ # Input sources for this stage.

1914

{ # Description of an input or output of an execution stage.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1915

"sizeBytes": "A String", # Size of the source, if measurable.

1916

"name": "A String", # Dataflow service generated name for this source.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1917

"userName": "A String", # Human-readable name for this source; may be user or system generated.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1918

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1919

},

1920

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1921

},

1922

],

1923

"displayData": [ # Pipeline level display data.

1924

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

1925

"durationValue": "A String", # Contains value if the data is of duration type.

1926

"javaClassValue": "A String", # Contains value if the data is of java class type.

1927

"key": "A String", # The key identifying the display data. This is intended to be used as a label for the display data when viewed in a dax monitoring system.

1928

"boolValue": True or False, # Contains value if the data is of a boolean type.

1929

"int64Value": "A String", # Contains value if the data is of int64 type.

1930

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1931

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1932

"label": "A String", # An optional label to display in a dax UI for the element.

1933

"floatValue": 3.14, # Contains value if the data is of float type.

1934

"url": "A String", # An optional full URL.

1935

"namespace": "A String", # The namespace for the key. This is usually a class name or programming language namespace (i.e. python module) which defines the display data. This allows a dax monitoring system to specially handle the data and perform custom rendering.

1936

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1937

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1938

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1939

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1940

"labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1941

"a_key": "A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1942

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1943

"steps": [ # Exactly one of step or steps_location should be specified. The top-level steps that constitute the entire job. Only retrieved with JOB_VIEW_ALL.

1944

{ # 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. 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.

1945

"name": "A String", # The name that identifies the step. This must be unique for each step with respect to all other steps in the Cloud Dataflow job.

1946

"properties": { # Named properties associated with the step. Each kind of predefined step has its own required set of properties. Must be provided on Create. Only retrieved with JOB_VIEW_ALL.

1947

"a_key": "", # Properties of the object.

1948

},

1949

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1950

},

1951

],

1952

"name": "A String", # The user-specified Cloud 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 returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,38}[a-z0-9])?`

1953

"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1954

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1955

"workerRegion": "A String", # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.

1956

"serviceKmsKeyName": "A String", # If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY

1957

"dataset": "A String", # The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset}

1958

"tempStoragePrefix": "A String", # 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}

1959

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1960

"a_key": "", # Properties of the object.

1961

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1962

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1963

{ # 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.

1964

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1965

"teardownPolicy": "A String", # 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1966

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1967

"a_key": "A String",

1968

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1969

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1970

"poolArgs": { # Extra arguments for this worker pool.

1971

"a_key": "", # Properties of the object. Contains field @type with type URL.

1972

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1973

"ipConfiguration": "A String", # Configuration for VM IPs.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

1974

"defaultPackageSet": "A String", # 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.

1975

"packages": [ # Packages to be installed on workers.

1976

{ # 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.

1977

"name": "A String", # The name of the package.

1978

"location": "A String", # The resource to read the package from. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket} bucket.storage.googleapis.com/

1979

},

1980

],

1981

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1982

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1983

"languageHint": "A String", # The suggested backend language.

1984

"workflowFileName": "A String", # The file to store the workflow in.

1985

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1986

"vmId": "A String", # The ID string of the VM.

1987

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1988

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1989

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1990

"logUploadLocation": "A String", # 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}

1991

"harnessCommand": "A String", # The command to launch the worker harness.

1992

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1993

"A String",

1994

],

1995

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1996

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1997

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1998

"tempStoragePrefix": "A String", # 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}

1999

"baseUrl": "A String", # 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/"

2000

"logDir": "A String", # The directory on the VM to store logs.

2001

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

2002

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

2003

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

2004

"workerId": "A String", # The ID of the worker running this pipeline.

2005

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

2006

"baseUrl": "A String", # 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/"

2007

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

2008

"tempStoragePrefix": "A String", # 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}

2009

},

2010

},

2011

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

2012

"sdkHarnessContainerImages": [ # Set of SDK harness containers needed to execute this pipeline. This will only be set in the Fn API path. For non-cross-language pipelines this should have only one entry. Cross-language pipelines will have two or more entries.

2013

{ # Defines a SDK harness container for executing Dataflow pipelines.

2014

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

2015

"useSingleCorePerContainer": True or False, # If true, recommends the Dataflow service to use only one core per SDK container instance with this image. If false (or unset) recommends using more than one core per SDK container instance with this image for efficiency. Note that Dataflow service may choose to override this property if needed.

2016

},

2017

],

2018

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

2019

"numWorkers": 42, # 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.

2020

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2021

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

2022

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

2023

"algorithm": "A String", # The algorithm to use for autoscaling.

2024

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2025

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2026

"numThreadsPerWorker": 42, # The number of threads per worker harness. If empty or unspecified, the service will choose a number of threads (according to the number of cores on the selected machine type for batch, or 1 by convention for streaming).

2027

"workerHarnessContainerImage": "A String", # Required. Docker container image that executes the Cloud Dataflow worker harness, residing in Google Container Registry. Deprecated for the Fn API path. Use sdk_harness_container_images instead.

2028

"dataDisks": [ # Data disks that are used by a VM in this workflow.

2029

{ # Describes the data disk used by a workflow job.

2030

"mountPoint": "A String", # Directory in a VM where disk is mounted.

2031

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

2032

"diskType": "A String", # 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 Cloud 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/project-id/zones/zone/diskTypes/pd-standard

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2033

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2034

],

2035

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

2036

"diskSourceImage": "A String", # Fully qualified source image for disks.

2037

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2038

},

2039

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2040

"workerZone": "A String", # The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity.

2041

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

2042

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

2043

"userAgent": { # A description of the process that generated the request.

2044

"a_key": "", # Properties of the object.

2045

},

2046

"experiments": [ # The list of experiments to enable.

2047

"A String",

2048

],

2049

"sdkPipelineOptions": { # The Cloud 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.

2050

"a_key": "", # Properties of the object.

2051

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2052

"internalExperiments": { # Experimental settings.

2053

"a_key": "", # Properties of the object. Contains field @type with type URL.

2054

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2055

"clusterManagerApiService": "A String", # 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".

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2056

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2057

"tempFiles": [ # A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

2058

"A String",

2059

],

2060

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

2061

"currentState": "A String", # 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.

2062

"currentStateTime": "A String", # The timestamp associated with the current state.

2063

"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.

2064

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2065

"startTime": "A String", # The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service.

2066

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

2067

"requestedState": "A String", # 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.

2068

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2069

"stages": { # A mapping from each stage to the information about that stage.

2070

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2071

"stepName": [ # 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.

2072

"A String",

2073

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

2074

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2075

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2076

},

2077

"type": "A String", # The type of Cloud Dataflow job.

2078

"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. 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 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.

2079

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

2080

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

2081

"a_key": "A String",

2082

},

2083

"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.

2084

"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.

2085

"fileDetails": [ # Identification of a File source used in the Dataflow job.

2086

{ # Metadata for a File connector used by the job.

2087

"filePattern": "A String", # File Pattern used to access files by the connector.

2088

},

2089

],

2090

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

2091

{ # Metadata for a Spanner connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2092

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2093

"projectId": "A String", # ProjectId accessed in the connection.

2094

"databaseId": "A String", # DatabaseId accessed in the connection.

2095

},

2096

],

2097

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

2098

{ # Metadata for a Datastore connector used by the job.

2099

"namespace": "A String", # Namespace used in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2100

"projectId": "A String", # ProjectId accessed in the connection.

2101

},

2102

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2103

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

2104

"version": "A String", # The version of the SDK used to run the job.

2105

"sdkSupportStatus": "A String", # The support status for this SDK version.

2106

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

2107

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2108

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

2109

{ # Metadata for a PubSub connector used by the job.

2110

"subscription": "A String", # Subscription used in the connection.

2111

"topic": "A String", # Topic accessed in the connection.

2112

},

2113

],

2114

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

2115

{ # Metadata for a BigQuery connector used by the job.

2116

"dataset": "A String", # Dataset accessed in the connection.

2117

"projectId": "A String", # Project accessed in the connection.

2118

"query": "A String", # Query used to access data in the connection.

2119

"table": "A String", # Table accessed in the connection.

2120

},

2121

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2122

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

2123

{ # Metadata for a BigTable connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2124

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2125

"tableId": "A String", # TableId accessed in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2126

"projectId": "A String", # ProjectId accessed in the connection.

2127

},

2128

],

2129

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

2130

"stepsLocation": "A String", # The GCS location where the steps are stored.

2131

}</pre>

Jon Wayne Parrott