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

2015-06-15 16:44:50 +0000

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Jon Wayne Parrott

7d5badb

2016-08-16 12:44:29 -0700

[diff] [blame]

78

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

79

</p>

80

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

81

82

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

83

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

84

</p>

85

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

86

87

88

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

89

</p>

90

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

91

92

Dmitry Frenkel

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">List the jobs of a project across all regions.</p>

95

96

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

97

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

98

Dmitry Frenkel

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

[diff] [blame]

99

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

100

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

101

102

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

103

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

104

Bu Sun Kim

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

[diff] [blame]

105

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

Dmitry Frenkel

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

[diff] [blame]

106

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

107

Bu Sun Kim

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

[diff] [blame]

108

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

Dmitry Frenkel

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

[diff] [blame]

109

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

110

Dmitry Frenkel

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

[diff] [blame]

111

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

112

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

113

114

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

115

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

116

Dan O'Meara

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

[diff] [blame]

117

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

Bu Sun Kim

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

[diff] [blame]

118

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

119

Dan O'Meara

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

[diff] [blame]

120

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

Dmitry Frenkel

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

[diff] [blame]

121

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

122

<h3>Method Details</h3>

123

Dmitry Frenkel

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

[diff] [blame]

124

<code class="details" id="aggregated">aggregated(projectId, pageToken=None, filter=None, pageSize=None, location=None, view=None, x__xgafv=None)</code>

Bu Sun Kim

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

[diff] [blame]

125

<pre>List the jobs of a project across all regions.

126

127

Args:

128

projectId: string, The project which owns the jobs. (required)

Dmitry Frenkel

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

[diff] [blame]

129

pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

Bu Sun Kim

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

[diff] [blame]

130

filter: string, The kind of filter to use.

Dmitry Frenkel

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

[diff] [blame]

131

Allowed values

132

UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`.

133

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.

134

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.

135

ACTIVE - Filters the jobs that are running ordered on the creation timestamp.

136

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.

137

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

Bu Sun Kim

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

[diff] [blame]

138

view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.

Dmitry Frenkel

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

[diff] [blame]

139

Allowed values

140

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.

141

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.

142

JOB_VIEW_ALL - Request all information available for this job.

143

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

Bu Sun Kim

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

[diff] [blame]

144

x__xgafv: string, V1 error format.

145

Allowed values

146

1 - v1 error format

147

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

148

149

Returns:

150

An object of the form:

151

Dmitry Frenkel

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

[diff] [blame]

152

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

Bu Sun Kim

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

[diff] [blame]

153

"jobs": [ # A subset of the requested job information.

Bu Sun Kim

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

[diff] [blame]

154

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

Dmitry Frenkel

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

[diff] [blame]

155

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

156

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

157

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

158

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

159

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

Bu Sun Kim

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

[diff] [blame]

160

},

Dmitry Frenkel

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

[diff] [blame]

161

],

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

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

175

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

176

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

177

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

178

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

179

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

Bu Sun Kim

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

[diff] [blame]

180

},

Dmitry Frenkel

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

[diff] [blame]

181

],

182

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

183

"A String",

184

],

185

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

186

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

187

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

188

"A String",

189

],

Bu Sun Kim

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

[diff] [blame]

190

},

191

],

Dmitry Frenkel

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

[diff] [blame]

192

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

193

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

194

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

195

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

196

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

197

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

198

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

199

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

200

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

201

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

202

},

203

],

204

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

205

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

206

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

207

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

208

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

209

},

210

],

211

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

212

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

213

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

214

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

215

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

216

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

217

},

218

],

219

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

220

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

221

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

222

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

223

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

224

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

225

},

226

],

Bu Sun Kim

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

[diff] [blame]

227

},

228

],

Dmitry Frenkel

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

[diff] [blame]

229

"displayData": [ # Pipeline level display data.

230

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

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

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

242

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

Bu Sun Kim

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

[diff] [blame]

243

},

Dmitry Frenkel

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

[diff] [blame]

244

],

245

},

246

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

247

"a_key": "A String",

248

},

249

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

250

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

251

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

252

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

253

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

254

},

255

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

Bu Sun Kim

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

[diff] [blame]

256

},

Dmitry Frenkel

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

[diff] [blame]

257

],

258

"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])?`

259

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

260

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

261

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

262

"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

263

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

264

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

265

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

266

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

Bu Sun Kim

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

[diff] [blame]

267

},

Dmitry Frenkel

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

[diff] [blame]

268

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

269

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

270

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

271

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

272

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

273

"a_key": "A String",

274

},

275

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

276

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

277

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

278

},

279

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

280

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

281

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

282

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

283

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

284

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

285

},

286

],

287

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

288

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

289

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

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

Bu Sun Kim

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

[diff] [blame]

299

"A String",

300

],

Dmitry Frenkel

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

[diff] [blame]

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

312

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

313

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

314

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

315

},

Bu Sun Kim

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

[diff] [blame]

316

},

Dmitry Frenkel

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

[diff] [blame]

317

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

318

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

319

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

320

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

321

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

322

},

323

],

324

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

325

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

326

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

327

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

328

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

329

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

330

},

331

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

332

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

333

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

334

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

335

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

336

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

337

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

338

"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

339

},

340

],

341

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

342

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

343

"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-20 12:08:20 -0700

[diff] [blame]

344

},

Dmitry Frenkel

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

[diff] [blame]

345

],

346

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

347

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

348

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

349

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

350

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

Bu Sun Kim

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

[diff] [blame]

351

},

Dmitry Frenkel

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

[diff] [blame]

352

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

Bu Sun Kim

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

[diff] [blame]

353

"A String",

354

],

Dmitry Frenkel

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

[diff] [blame]

355

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

356

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

357

},

358

"internalExperiments": { # Experimental settings.

359

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

360

},

361

"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

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

[diff] [blame]

362

},

Dmitry Frenkel

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

[diff] [blame]

363

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

364

"A String",

365

],

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

384

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

385

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

386

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

387

"a_key": "A String",

388

},

389

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

390

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

391

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

392

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

393

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

394

},

395

],

396

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

397

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

398

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

399

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

400

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

401

},

402

],

403

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

404

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

405

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

406

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

407

},

408

],

409

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

410

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

411

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

412

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

413

},

414

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

415

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

416

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

417

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

418

},

419

],

420

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

421

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

422

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

423

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

424

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

425

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

426

},

427

],

428

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

429

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

430

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

431

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

432

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

},

],

},

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

Bu Sun Kim

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

[diff] [blame]

437

},

438

],

Dmitry Frenkel

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

[diff] [blame]

439

"failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

440

{ # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

441

"name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

442

},

443

],

444

"nextPageToken": "A String", # Set if there may be more results than fit in this response.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="aggregated_next">aggregated_next(previous_request, previous_response)</code>

450

<pre>Retrieves the next page of results.

451

452

Args:

453

previous_request: The request for the previous page. (required)

454

previous_response: The response from the request for the previous page. (required)

455

456

Returns:

Bu Sun Kim

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

[diff] [blame]

457

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

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

[diff] [blame]

458

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dmitry Frenkel

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

[diff] [blame]

463

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

464

<pre>Close httplib2 connections.</pre>

465

</div>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

466

Dmitry Frenkel

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

[diff] [blame]

467

468

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

469

<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]

470

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

471

Args:

Sai Cheemalapati

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

[diff] [blame]

472

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

Dan O'Meara

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

[diff] [blame]

473

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

474

The object takes the form of:

475

Sai Cheemalapati

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

[diff] [blame]

476

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

Dmitry Frenkel

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

[diff] [blame]

477

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

478

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

479

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

480

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

481

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

482

},

483

],

484

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

485

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

486

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

487

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

488

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

489

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

490

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

491

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

492

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

493

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

494

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

495

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

496

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

497

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

498

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

499

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

500

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

501

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

502

},

503

],

504

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

505

"A String",

506

],

507

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

508

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

509

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

"A String",

],

},

],

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

515

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

516

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

517

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

518

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

519

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

520

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

521

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

522

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

523

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

524

},

525

],

526

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

527

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

528

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

529

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

530

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

531

},

532

],

533

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

534

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

535

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

536

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

537

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

538

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

539

},

540

],

541

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

542

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

543

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

544

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

545

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

546

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

552

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

553

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

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

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

562

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

563

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

564

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

569

"a_key": "A String",

570

},

571

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

572

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

573

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

574

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

575

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

576

},

577

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

578

},

579

],

580

"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])?`

581

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

582

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

583

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

584

"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

585

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

586

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

587

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

588

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

589

},

590

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

591

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

592

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

593

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

594

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

595

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

596

},

Dmitry Frenkel

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

[diff] [blame]

597

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

598

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

599

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

600

},

601

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

602

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

603

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

604

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

605

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

606

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

607

},

608

],

609

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

610

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

611

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

612

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

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

"A String",

622

],

Dmitry Frenkel

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

[diff] [blame]

623

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

624

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

625

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

626

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

627

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

628

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

629

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

630

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

631

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

632

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

633

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

634

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

635

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

636

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

637

},

638

},

639

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

640

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

641

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

642

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

643

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

644

},

645

],

646

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

647

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

648

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

649

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

650

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

651

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

652

},

653

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

654

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

655

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

656

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

657

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

658

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

659

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

660

"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

661

},

662

],

663

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

664

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

665

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

666

},

667

],

668

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

669

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

670

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

671

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

672

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

673

},

674

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

675

"A String",

676

],

677

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

678

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

679

},

680

"internalExperiments": { # Experimental settings.

681

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

682

},

683

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

684

},

685

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

686

"A String",

687

],

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

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

699

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

706

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

707

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

708

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

709

"a_key": "A String",

710

},

711

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

712

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

713

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

714

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

715

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

716

},

717

],

718

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

719

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

720

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

721

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

722

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

723

},

724

],

725

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

726

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

727

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

728

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

729

},

730

],

731

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

732

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

733

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

734

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

735

},

736

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

737

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

738

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

739

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

740

},

741

],

742

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

743

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

744

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

745

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

746

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

747

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

748

},

749

],

750

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

751

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

752

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

753

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

754

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

},

],

},

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

759

}

760

761

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

762

Allowed values

763

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.

764

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.

765

JOB_VIEW_ALL - Request all information available for this job.

766

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

767

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

768

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

769

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

776

777

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

778

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

779

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

780

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

781

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

782

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

783

},

784

],

785

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

786

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

787

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

788

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

Bu Sun Kim

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

[diff] [blame]

789

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

790

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

Bu Sun Kim

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

[diff] [blame]

791

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

Dmitry Frenkel

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

[diff] [blame]

792

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

793

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

794

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

795

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

796

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

797

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

798

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

799

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

800

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

801

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

802

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

Bu Sun Kim

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

[diff] [blame]

803

},

804

],

Bu Sun Kim

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

[diff] [blame]

805

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

806

"A String",

807

],

Dmitry Frenkel

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

[diff] [blame]

808

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

Bu Sun Kim

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

[diff] [blame]

809

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

Dmitry Frenkel

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

[diff] [blame]

810

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

811

"A String",

812

],

Bu Sun Kim

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

[diff] [blame]

813

},

814

],

815

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

Dmitry Frenkel

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

[diff] [blame]

816

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

817

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

818

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

819

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

820

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

821

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

Bu Sun Kim

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

[diff] [blame]

822

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

823

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

824

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

Dmitry Frenkel

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

[diff] [blame]

825

},

826

],

827

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

828

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

829

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

830

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

831

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

832

},

833

],

834

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

835

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

836

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

837

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

838

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

839

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

840

},

841

],

842

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

843

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

Bu Sun Kim

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

[diff] [blame]

844

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

845

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

Bu Sun Kim

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

[diff] [blame]

846

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

847

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

848

},

849

],

Dmitry Frenkel

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

[diff] [blame]

850

},

851

],

852

"displayData": [ # Pipeline level display data.

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

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

Bu Sun Kim

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

[diff] [blame]

866

},

867

],

868

},

Dmitry Frenkel

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

[diff] [blame]

869

"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-07-22 17:02:09 -0700

[diff] [blame]

870

"a_key": "A String",

871

},

Dmitry Frenkel

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

[diff] [blame]

872

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

873

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

874

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

875

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

876

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

877

},

878

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

879

},

880

],

881

"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])?`

882

"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-07-22 17:02:09 -0700

[diff] [blame]

883

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

884

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

885

"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

886

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

887

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

888

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

889

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

890

},

Dmitry Frenkel

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

[diff] [blame]

891

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

892

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

893

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

894

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

895

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

896

"a_key": "A String",

897

},

Dmitry Frenkel

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

[diff] [blame]

898

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

899

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

900

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

901

},

Bu Sun Kim

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

[diff] [blame]

902

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

Dmitry Frenkel

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

[diff] [blame]

903

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

904

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

905

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

906

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

907

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

908

},

909

],

910

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

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

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

920

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

921

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

922

"A String",

923

],

924

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

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

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

935

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

936

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

937

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

938

},

939

},

940

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

941

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

942

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

943

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

944

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

945

},

946

],

947

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

948

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

949

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

950

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

951

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

952

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

953

},

Dmitry Frenkel

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

[diff] [blame]

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

"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-07-22 17:02:09 -0700

[diff] [blame]

962

},

Dmitry Frenkel

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

[diff] [blame]

963

],

964

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

965

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

966

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

967

},

Bu Sun Kim

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

[diff] [blame]

968

],

Dmitry Frenkel

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

[diff] [blame]

969

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

970

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

971

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

972

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

973

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

974

},

975

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

976

"A String",

977

],

978

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

979

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

980

},

Bu Sun Kim

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

[diff] [blame]

981

"internalExperiments": { # Experimental settings.

982

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

Bu Sun Kim

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

[diff] [blame]

983

},

Dmitry Frenkel

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

[diff] [blame]

984

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

985

},

Dmitry Frenkel

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

[diff] [blame]

986

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

987

"A String",

988

],

989

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

990

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

991

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

992

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

993

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

994

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

995

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

996

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

997

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

998

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

999

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

1000

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

1001

"A String",

1002

],

Bu Sun Kim

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

[diff] [blame]

1003

},

Bu Sun Kim

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

[diff] [blame]

1004

},

Dmitry Frenkel

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

[diff] [blame]

1005

},

1006

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

1007

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

1008

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

1009

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

1010

"a_key": "A String",

1011

},

1012

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

1013

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

1014

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

1015

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

1016

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

1017

},

1018

],

1019

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

1020

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

Bu Sun Kim

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

[diff] [blame]

1021

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

Dmitry Frenkel

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

[diff] [blame]

1022

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

1023

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

1024

},

1025

],

1026

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

1027

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

1028

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

Bu Sun Kim

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

[diff] [blame]

1029

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

1030

},

1031

],

Dmitry Frenkel

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

[diff] [blame]

1032

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

1033

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

1034

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

1035

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

1036

},

Bu Sun Kim

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

[diff] [blame]

1037

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

1038

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

1039

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

1040

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

1041

},

1042

],

1043

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

1044

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

1045

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

1046

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

1047

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

1048

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

1049

},

1050

],

Dmitry Frenkel

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

[diff] [blame]

1051

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

1052

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

1053

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

1054

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

1055

"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, jobId, location=None, view=None, x__xgafv=None)</code>

1065

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

1066

1067

Args:

1068

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

1069

jobId: string, The job ID. (required)

1070

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

1071

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

1072

Allowed values

1073

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.

1074

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.

1075

JOB_VIEW_ALL - Request all information available for this job.

1076

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

1077

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1084

1085

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

1086

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

1087

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

1088

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

1089

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

1090

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

1091

},

1092

],

1093

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

1094

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

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

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

1104

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

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

},

1112

],

1113

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

1114

"A String",

1115

],

1116

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

1117

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

1118

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

"A String",

],

},

],

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

1124

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

1125

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

1126

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

1127

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

1128

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

1129

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

1130

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

1131

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

1132

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

1133

},

1134

],

1135

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

1136

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

1137

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

1138

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

1139

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

1140

},

1141

],

1142

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

1143

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

1144

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

1145

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

1146

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

1147

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

1148

},

1149

],

1150

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

1151

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

1152

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

1153

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

1154

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1155

"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.

1161

{ # Data provided with a pipeline or transform to provide descriptive info.

1162

"durationValue": "A String", # Contains value if the data is of duration type.

1163

"javaClassValue": "A String", # Contains value if the data is of java class type.

1164

"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.

1165

"boolValue": True or False, # Contains value if the data is of a boolean type.

1166

"int64Value": "A String", # Contains value if the data is of int64 type.

1167

"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.

1168

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1169

"label": "A String", # An optional label to display in a dax UI for the element.

1170

"floatValue": 3.14, # Contains value if the data is of float type.

1171

"url": "A String", # An optional full URL.

1172

"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.

1173

"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.

1178

"a_key": "A String",

1179

},

1180

"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.

1181

{ # 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.

1182

"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.

1183

"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.

1184

"a_key": "", # Properties of the object.

1185

},

1186

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1187

},

1188

],

1189

"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])?`

1190

"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.

1191

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1192

"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.

1193

"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

1194

"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}

1195

"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}

1196

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1197

"a_key": "", # Properties of the object.

1198

},

1199

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1200

{ # 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.

1201

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1202

"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.

1203

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1204

"a_key": "A String",

1205

},

1206

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1207

"poolArgs": { # Extra arguments for this worker pool.

1208

"a_key": "", # Properties of the object. Contains field @type with type URL.

1209

},

1210

"ipConfiguration": "A String", # Configuration for VM IPs.

1211

"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.

1212

"packages": [ # Packages to be installed on workers.

1213

{ # 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.

1214

"name": "A String", # The name of the package.

1215

"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/

1216

},

1217

],

1218

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1219

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1220

"languageHint": "A String", # The suggested backend language.

1221

"workflowFileName": "A String", # The file to store the workflow in.

1222

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1223

"vmId": "A String", # The ID string of the VM.

1224

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1225

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1226

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1227

"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}

1228

"harnessCommand": "A String", # The command to launch the worker harness.

1229

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1230

"A String",

1231

],

1232

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1233

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1234

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1235

"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}

1236

"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/"

1237

"logDir": "A String", # The directory on the VM to store logs.

1238

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1239

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1240

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1241

"workerId": "A String", # The ID of the worker running this pipeline.

1242

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1243

"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/"

1244

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1245

"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}

1246

},

1247

},

1248

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1249

"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.

1250

{ # Defines a SDK harness container for executing Dataflow pipelines.

1251

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1252

"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.

1253

},

1254

],

1255

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1256

"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.

1257

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1258

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1259

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1260

"algorithm": "A String", # The algorithm to use for autoscaling.

1261

},

1262

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1263

"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).

1264

"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.

1265

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1266

{ # Describes the data disk used by a workflow job.

1267

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1268

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1269

"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

1270

},

1271

],

1272

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1273

"diskSourceImage": "A String", # Fully qualified source image for disks.

1274

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1275

},

1276

],

1277

"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.

1278

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1279

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1280

"userAgent": { # A description of the process that generated the request.

1281

"a_key": "", # Properties of the object.

1282

},

1283

"experiments": [ # The list of experiments to enable.

1284

"A String",

1285

],

1286

"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.

1287

"a_key": "", # Properties of the object.

1288

},

1289

"internalExperiments": { # Experimental settings.

1290

"a_key": "", # Properties of the object. Contains field @type with type URL.

1291

},

1292

"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".

1293

},

1294

"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}

1295

"A String",

1296

],

1297

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

1298

"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.

1299

"currentStateTime": "A String", # The timestamp associated with the current state.

1300

"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.

1301

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1302

"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.

1303

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1304

"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.

1305

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1306

"stages": { # A mapping from each stage to the information about that stage.

1307

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1308

"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.

1315

"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.

1316

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1317

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1318

"a_key": "A String",

1319

},

1320

"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.

1321

"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]

1322

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1323

{ # Metadata for a File connector used by the job.

1324

"filePattern": "A String", # File Pattern used to access files by the connector.

1325

},

1326

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1327

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1328

{ # Metadata for a Spanner connector used by the job.

1329

"instanceId": "A String", # InstanceId accessed in the connection.

1330

"projectId": "A String", # ProjectId accessed in the connection.

1331

"databaseId": "A String", # DatabaseId accessed in the connection.

1332

},

1333

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1334

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1335

{ # Metadata for a Datastore connector used by the job.

1336

"namespace": "A String", # Namespace used in the connection.

1337

"projectId": "A String", # ProjectId accessed in the connection.

1338

},

1339

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1340

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1341

"version": "A String", # The version of the SDK used to run the job.

1342

"sdkSupportStatus": "A String", # The support status for this SDK version.

1343

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1344

},

1345

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1346

{ # Metadata for a PubSub connector used by the job.

1347

"subscription": "A String", # Subscription used in the connection.

1348

"topic": "A String", # Topic accessed in the connection.

1349

},

1350

],

1351

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1352

{ # Metadata for a BigQuery connector used by the job.

1353

"dataset": "A String", # Dataset accessed in the connection.

1354

"projectId": "A String", # Project accessed in the connection.

1355

"query": "A String", # Query used to access data in the connection.

1356

"table": "A String", # Table accessed in the connection.

1357

},

1358

],

1359

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1360

{ # Metadata for a BigTable connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1361

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1362

"tableId": "A String", # TableId accessed in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1363

"projectId": "A String", # ProjectId accessed in the connection.

1364

},

1365

],

1366

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1367

"stepsLocation": "A String", # The GCS location where the steps are stored.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1372

<code class="details" id="getMetrics">getMetrics(projectId, jobId, startTime=None, location=None, x__xgafv=None)</code>

1373

<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`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1374

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1375

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1376

projectId: string, A project id. (required)

1377

jobId: string, The job to get metrics for. (required)

1378

startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

1379

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

1380

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1381

Allowed values

1382

1 - v1 error format

1383

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1384

1385

Returns:

1386

An object of the form:

1387

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1388

{ # 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.

1389

"metrics": [ # All metrics for this job.

1390

{ # Describes the state of a metric.

1391

"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.

1392

"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.

1393

"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.

1394

"name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.

1395

"name": "A String", # Worker-defined metric name.

1396

"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]

1397

"a_key": "A String",

1398

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1399

"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]

1400

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1401

"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.

1402

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1403

"distribution": "", # A struct value describing properties of a distribution of numeric values.

1404

"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.

1405

"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.

1406

"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.

1407

"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]

1408

},

1409

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1410

"metricTime": "A String", # Timestamp as of which metric values are current.

}</pre>

</div>

<code class="details" id="list">list(projectId, filter=None, pageToken=None, view=None, location=None, pageSize=None, x__xgafv=None)</code>

1416

<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`.

1417

1418

Args:

1419

projectId: string, The project which owns the jobs. (required)

1420

filter: string, The kind of filter to use.

1421

Allowed values

1422

UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`.

1423

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.

1424

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.

1425

ACTIVE - Filters the jobs that are running ordered on the creation timestamp.

1426

pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

1427

view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.

1428

Allowed values

1429

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.

1430

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.

1431

JOB_VIEW_ALL - Request all information available for this job.

1432

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

1433

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1434

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.

1435

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1442

1443

{ # 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 {}.

1444

"jobs": [ # A subset of the requested job information.

1445

{ # Defines a job to be run by the Cloud Dataflow service.

1446

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1447

{ # A message describing the state of a particular execution stage.

1448

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1449

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1450

"executionStageName": "A String", # The name of the execution stage.

1451

},

1452

],

1453

"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.

1454

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1455

{ # Description of the type, names/ids, and input/outputs for a transform.

1456

"name": "A String", # User provided name for this transform instance.

1457

"displayData": [ # Transform-specific display data.

1458

{ # Data provided with a pipeline or transform to provide descriptive info.

1459

"durationValue": "A String", # Contains value if the data is of duration type.

1460

"javaClassValue": "A String", # Contains value if the data is of java class type.

1461

"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.

1462

"boolValue": True or False, # Contains value if the data is of a boolean type.

1463

"int64Value": "A String", # Contains value if the data is of int64 type.

1464

"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.

1465

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1466

"label": "A String", # An optional label to display in a dax UI for the element.

1467

"floatValue": 3.14, # Contains value if the data is of float type.

1468

"url": "A String", # An optional full URL.

1469

"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.

1470

"strValue": "A String", # Contains value if the data is of string type.

1471

},

1472

],

1473

"inputCollectionName": [ # User names for all collection inputs to this transform.

1474

"A String",

1475

],

1476

"id": "A String", # SDK generated id of this transform instance.

1477

"kind": "A String", # Type of transform.

1478

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1484

{ # 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.

1485

"kind": "A String", # Type of tranform this stage is executing.

1486

"id": "A String", # Dataflow service generated id for this stage.

1487

"name": "A String", # Dataflow service generated name for this stage.

1488

"componentTransform": [ # Transforms that comprise this execution stage.

1489

{ # Description of a transform executed as part of an execution stage.

1490

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1491

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1492

"name": "A String", # Dataflow service generated name for this source.

1493

},

1494

],

1495

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1496

{ # Description of an interstitial value between transforms in an execution stage.

1497

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1498

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1499

"name": "A String", # Dataflow service generated name for this source.

1500

},

1501

],

1502

"outputSource": [ # Output sources for this stage.

1503

{ # Description of an input or output of an execution stage.

1504

"sizeBytes": "A String", # Size of the source, if measurable.

1505

"name": "A String", # Dataflow service generated name for this source.

1506

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1507

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1508

},

1509

],

1510

"inputSource": [ # Input sources for this stage.

1511

{ # Description of an input or output of an execution stage.

1512

"sizeBytes": "A String", # Size of the source, if measurable.

1513

"name": "A String", # Dataflow service generated name for this source.

1514

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1515

"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.

1521

{ # Data provided with a pipeline or transform to provide descriptive info.

1522

"durationValue": "A String", # Contains value if the data is of duration type.

1523

"javaClassValue": "A String", # Contains value if the data is of java class type.

1524

"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.

1525

"boolValue": True or False, # Contains value if the data is of a boolean type.

1526

"int64Value": "A String", # Contains value if the data is of int64 type.

1527

"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.

1528

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1529

"label": "A String", # An optional label to display in a dax UI for the element.

1530

"floatValue": 3.14, # Contains value if the data is of float type.

1531

"url": "A String", # An optional full URL.

1532

"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.

1533

"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.

1538

"a_key": "A String",

1539

},

1540

"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.

1541

{ # 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.

1542

"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.

1543

"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.

1544

"a_key": "", # Properties of the object.

1545

},

1546

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1547

},

1548

],

1549

"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])?`

1550

"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.

1551

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1552

"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.

1553

"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

1554

"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}

1555

"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}

1556

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1557

"a_key": "", # Properties of the object.

1558

},

1559

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1560

{ # 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.

1561

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1562

"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.

1563

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1564

"a_key": "A String",

1565

},

1566

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1567

"poolArgs": { # Extra arguments for this worker pool.

1568

"a_key": "", # Properties of the object. Contains field @type with type URL.

1569

},

1570

"ipConfiguration": "A String", # Configuration for VM IPs.

1571

"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.

1572

"packages": [ # Packages to be installed on workers.

1573

{ # 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.

1574

"name": "A String", # The name of the package.

1575

"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/

1576

},

1577

],

1578

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1579

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1580

"languageHint": "A String", # The suggested backend language.

1581

"workflowFileName": "A String", # The file to store the workflow in.

1582

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1583

"vmId": "A String", # The ID string of the VM.

1584

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1585

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1586

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1587

"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}

1588

"harnessCommand": "A String", # The command to launch the worker harness.

1589

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1590

"A String",

1591

],

1592

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1593

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1594

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1595

"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}

1596

"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/"

1597

"logDir": "A String", # The directory on the VM to store logs.

1598

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1599

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1600

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1601

"workerId": "A String", # The ID of the worker running this pipeline.

1602

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1603

"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/"

1604

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1605

"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}

1606

},

1607

},

1608

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1609

"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.

1610

{ # Defines a SDK harness container for executing Dataflow pipelines.

1611

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1612

"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.

1613

},

1614

],

1615

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1616

"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.

1617

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1618

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1619

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1620

"algorithm": "A String", # The algorithm to use for autoscaling.

1621

},

1622

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1623

"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).

1624

"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.

1625

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1626

{ # Describes the data disk used by a workflow job.

1627

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1628

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1629

"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

1630

},

1631

],

1632

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1633

"diskSourceImage": "A String", # Fully qualified source image for disks.

1634

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1635

},

1636

],

1637

"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.

1638

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1639

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1640

"userAgent": { # A description of the process that generated the request.

1641

"a_key": "", # Properties of the object.

1642

},

1643

"experiments": [ # The list of experiments to enable.

1644

"A String",

1645

],

1646

"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.

1647

"a_key": "", # Properties of the object.

1648

},

1649

"internalExperiments": { # Experimental settings.

1650

"a_key": "", # Properties of the object. Contains field @type with type URL.

1651

},

1652

"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".

1653

},

1654

"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}

1655

"A String",

1656

],

1657

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

1658

"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.

1659

"currentStateTime": "A String", # The timestamp associated with the current state.

1660

"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.

1661

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1662

"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.

1663

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1664

"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.

1665

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1666

"stages": { # A mapping from each stage to the information about that stage.

1667

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1668

"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.

1675

"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.

1676

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1677

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1678

"a_key": "A String",

1679

},

1680

"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.

1681

"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.

1682

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1683

{ # Metadata for a File connector used by the job.

1684

"filePattern": "A String", # File Pattern used to access files by the connector.

1685

},

1686

],

1687

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1688

{ # Metadata for a Spanner connector used by the job.

1689

"instanceId": "A String", # InstanceId accessed in the connection.

1690

"projectId": "A String", # ProjectId accessed in the connection.

1691

"databaseId": "A String", # DatabaseId accessed in the connection.

1692

},

1693

],

1694

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1695

{ # Metadata for a Datastore connector used by the job.

1696

"namespace": "A String", # Namespace used in the connection.

1697

"projectId": "A String", # ProjectId accessed in the connection.

1698

},

1699

],

1700

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1701

"version": "A String", # The version of the SDK used to run the job.

1702

"sdkSupportStatus": "A String", # The support status for this SDK version.

1703

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1704

},

1705

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1706

{ # Metadata for a PubSub connector used by the job.

1707

"subscription": "A String", # Subscription used in the connection.

1708

"topic": "A String", # Topic accessed in the connection.

1709

},

1710

],

1711

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1712

{ # Metadata for a BigQuery connector used by the job.

1713

"dataset": "A String", # Dataset accessed in the connection.

1714

"projectId": "A String", # Project accessed in the connection.

1715

"query": "A String", # Query used to access data in the connection.

1716

"table": "A String", # Table accessed in the connection.

1717

},

1718

],

1719

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1720

{ # Metadata for a BigTable connector used by the job.

1721

"instanceId": "A String", # InstanceId accessed in the connection.

1722

"tableId": "A String", # TableId accessed in the connection.

1723

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

1728

},

1729

],

1730

"failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1731

{ # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

1732

"name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1733

},

1734

],

1735

"nextPageToken": "A String", # Set if there may be more results than fit in this response.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1741

<pre>Retrieves the next page of results.

1742

1743

Args:

1744

previous_request: The request for the previous page. (required)

1745

previous_response: The response from the request for the previous page. (required)

1746

1747

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1748

A request object that you can call 'execute()' on to request the next

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1749

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]

1754

<code class="details" id="snapshot">snapshot(projectId, jobId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1755

<pre>Snapshot the state of a streaming job.

1756

1757

Args:

1758

projectId: string, The project which owns the job to be snapshotted. (required)

1759

jobId: string, The job to be snapshotted. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1760

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1761

The object takes the form of:

1762

1763

{ # Request to create a snapshot of a job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1764

"ttl": "A String", # TTL for the snapshot.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1765

"snapshotSources": True or False, # If true, perform snapshots for sources which support this.

1766

"description": "A String", # User specified description of the snapshot. Maybe empty.

1767

"location": "A String", # The location that contains this job.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1768

}

1769

1770

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1777

1778

{ # Represents a snapshot of a job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1779

"projectId": "A String", # The project this snapshot belongs to.

1780

"diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY state.

1781

"creationTime": "A String", # The time this snapshot was created.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1782

"ttl": "A String", # The time after which this snapshot will be automatically deleted.

1783

"state": "A String", # State of the snapshot.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1784

"sourceJobId": "A String", # The job this snapshot was created from.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1785

"description": "A String", # User specified description of the snapshot. Maybe empty.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1786

"id": "A String", # The unique ID of this snapshot.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1787

"pubsubMetadata": [ # PubSub snapshot metadata.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1788

{ # Represents a Pubsub snapshot.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1789

"expireTime": "A String", # The expire time of the Pubsub snapshot.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1790

"topicName": "A String", # The name of the Pubsub topic.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1791

"snapshotName": "A String", # The name of the Pubsub snapshot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1792

},

1793

],

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]

1798

<code class="details" id="update">update(projectId, jobId, body=None, location=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1799

<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]

1800

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1801

Args:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1802

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

1803

jobId: string, The job ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1804

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1805

The object takes the form of:

1806

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1807

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1808

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1809

{ # A message describing the state of a particular execution stage.

1810

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1811

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1812

"executionStageName": "A String", # The name of the execution stage.

1813

},

1814

],

1815

"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.

1816

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1817

{ # Description of the type, names/ids, and input/outputs for a transform.

1818

"name": "A String", # User provided name for this transform instance.

1819

"displayData": [ # Transform-specific display data.

1820

{ # Data provided with a pipeline or transform to provide descriptive info.

1821

"durationValue": "A String", # Contains value if the data is of duration type.

1822

"javaClassValue": "A String", # Contains value if the data is of java class type.

1823

"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.

1824

"boolValue": True or False, # Contains value if the data is of a boolean type.

1825

"int64Value": "A String", # Contains value if the data is of int64 type.

1826

"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.

1827

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1828

"label": "A String", # An optional label to display in a dax UI for the element.

1829

"floatValue": 3.14, # Contains value if the data is of float type.

1830

"url": "A String", # An optional full URL.

1831

"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.

1832

"strValue": "A String", # Contains value if the data is of string type.

1833

},

1834

],

1835

"inputCollectionName": [ # User names for all collection inputs to this transform.

1836

"A String",

1837

],

1838

"id": "A String", # SDK generated id of this transform instance.

1839

"kind": "A String", # Type of transform.

1840

"outputCollectionName": [ # User names for all collection outputs to this transform.

"A String",

],

},

],

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1846

{ # 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.

1847

"kind": "A String", # Type of tranform this stage is executing.

1848

"id": "A String", # Dataflow service generated id for this stage.

1849

"name": "A String", # Dataflow service generated name for this stage.

1850

"componentTransform": [ # Transforms that comprise this execution stage.

1851

{ # Description of a transform executed as part of an execution stage.

1852

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1853

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1854

"name": "A String", # Dataflow service generated name for this source.

1855

},

1856

],

1857

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1858

{ # Description of an interstitial value between transforms in an execution stage.

1859

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1860

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1861

"name": "A String", # Dataflow service generated name for this source.

1862

},

1863

],

1864

"outputSource": [ # Output sources for this stage.

1865

{ # Description of an input or output of an execution stage.

1866

"sizeBytes": "A String", # Size of the source, if measurable.

1867

"name": "A String", # Dataflow service generated name for this source.

1868

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1869

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1870

},

1871

],

1872

"inputSource": [ # Input sources for this stage.

1873

{ # Description of an input or output of an execution stage.

1874

"sizeBytes": "A String", # Size of the source, if measurable.

1875

"name": "A String", # Dataflow service generated name for this source.

1876

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1877

"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.

1883

{ # Data provided with a pipeline or transform to provide descriptive info.

1884

"durationValue": "A String", # Contains value if the data is of duration type.

1885

"javaClassValue": "A String", # Contains value if the data is of java class type.

1886

"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.

1887

"boolValue": True or False, # Contains value if the data is of a boolean type.

1888

"int64Value": "A String", # Contains value if the data is of int64 type.

1889

"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.

1890

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1891

"label": "A String", # An optional label to display in a dax UI for the element.

1892

"floatValue": 3.14, # Contains value if the data is of float type.

1893

"url": "A String", # An optional full URL.

1894

"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.

1895

"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.

1900

"a_key": "A String",

1901

},

1902

"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.

1903

{ # 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.

1904

"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.

1905

"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.

1906

"a_key": "", # Properties of the object.

1907

},

1908

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1909

},

1910

],

1911

"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])?`

1912

"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.

1913

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1914

"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.

1915

"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

1916

"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}

1917

"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}

1918

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1919

"a_key": "", # Properties of the object.

1920

},

1921

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1922

{ # 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.

1923

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1924

"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.

1925

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1926

"a_key": "A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1927

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1928

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1929

"poolArgs": { # Extra arguments for this worker pool.

1930

"a_key": "", # Properties of the object. Contains field @type with type URL.

1931

},

1932

"ipConfiguration": "A String", # Configuration for VM IPs.

1933

"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.

1934

"packages": [ # Packages to be installed on workers.

1935

{ # 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.

1936

"name": "A String", # The name of the package.

1937

"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/

1938

},

1939

],

1940

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1941

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1942

"languageHint": "A String", # The suggested backend language.

1943

"workflowFileName": "A String", # The file to store the workflow in.

1944

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1945

"vmId": "A String", # The ID string of the VM.

1946

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1947

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1948

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1949

"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}

1950

"harnessCommand": "A String", # The command to launch the worker harness.

1951

"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]

1952

"A String",

1953

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1954

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1955

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1956

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1957

"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}

1958

"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/"

1959

"logDir": "A String", # The directory on the VM to store logs.

1960

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1961

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1962

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1963

"workerId": "A String", # The ID of the worker running this pipeline.

1964

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1965

"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/"

1966

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1967

"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}

1968

},

1969

},

1970

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1971

"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.

1972

{ # Defines a SDK harness container for executing Dataflow pipelines.

1973

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1974

"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.

1975

},

1976

],

1977

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1978

"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.

1979

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1980

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1981

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1982

"algorithm": "A String", # The algorithm to use for autoscaling.

1983

},

1984

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1985

"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).

1986

"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.

1987

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1988

{ # Describes the data disk used by a workflow job.

1989

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1990

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1991

"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

1992

},

1993

],

1994

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1995

"diskSourceImage": "A String", # Fully qualified source image for disks.

1996

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1997

},

1998

],

1999

"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.

2000

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

2001

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

2002

"userAgent": { # A description of the process that generated the request.

2003

"a_key": "", # Properties of the object.

2004

},

2005

"experiments": [ # The list of experiments to enable.

2006

"A String",

2007

],

2008

"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.

2009

"a_key": "", # Properties of the object.

2010

},

2011

"internalExperiments": { # Experimental settings.

2012

"a_key": "", # Properties of the object. Contains field @type with type URL.

2013

},

2014

"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".

2015

},

2016

"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}

2017

"A String",

2018

],

2019

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

2020

"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.

2021

"currentStateTime": "A String", # The timestamp associated with the current state.

2022

"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.

2023

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2024

"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.

2025

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

2026

"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.

2027

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2028

"stages": { # A mapping from each stage to the information about that stage.

2029

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2030

"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.

2037

"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.

2038

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

2039

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

2040

"a_key": "A String",

2041

},

2042

"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.

2043

"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.

2044

"fileDetails": [ # Identification of a File source used in the Dataflow job.

2045

{ # Metadata for a File connector used by the job.

2046

"filePattern": "A String", # File Pattern used to access files by the connector.

2047

},

2048

],

2049

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

2050

{ # Metadata for a Spanner connector used by the job.

2051

"instanceId": "A String", # InstanceId accessed in the connection.

2052

"projectId": "A String", # ProjectId accessed in the connection.

2053

"databaseId": "A String", # DatabaseId accessed in the connection.

2054

},

2055

],

2056

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

2057

{ # Metadata for a Datastore connector used by the job.

2058

"namespace": "A String", # Namespace used in the connection.

2059

"projectId": "A String", # ProjectId accessed in the connection.

2060

},

2061

],

2062

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

2063

"version": "A String", # The version of the SDK used to run the job.

2064

"sdkSupportStatus": "A String", # The support status for this SDK version.

2065

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

2066

},

2067

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

2068

{ # Metadata for a PubSub connector used by the job.

2069

"subscription": "A String", # Subscription used in the connection.

2070

"topic": "A String", # Topic accessed in the connection.

2071

},

2072

],

2073

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

2074

{ # Metadata for a BigQuery connector used by the job.

2075

"dataset": "A String", # Dataset accessed in the connection.

2076

"projectId": "A String", # Project accessed in the connection.

2077

"query": "A String", # Query used to access data in the connection.

2078

"table": "A String", # Table accessed in the connection.

2079

},

2080

],

2081

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

2082

{ # Metadata for a BigTable connector used by the job.

2083

"instanceId": "A String", # InstanceId accessed in the connection.

2084

"tableId": "A String", # TableId accessed in the connection.

2085

"projectId": "A String", # ProjectId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

2090

}

2091

2092

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2093

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2100

2101

{ # Defines a job to be run by the Cloud Dataflow service.

2102

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

2103

{ # A message describing the state of a particular execution stage.

2104

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

2105

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

2106

"executionStageName": "A String", # The name of the execution stage.

2107

},

2108

],

2109

"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.

2110

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

2111

{ # Description of the type, names/ids, and input/outputs for a transform.

2112

"name": "A String", # User provided name for this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2113

"displayData": [ # Transform-specific display data.

2114

{ # Data provided with a pipeline or transform to provide descriptive info.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2115

"durationValue": "A String", # Contains value if the data is of duration type.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2116

"javaClassValue": "A String", # Contains value if the data is of java class type.

2117

"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]

2118

"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]

2119

"int64Value": "A String", # Contains value if the data is of int64 type.

2120

"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.

2121

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2122

"label": "A String", # An optional label to display in a dax UI for the element.

2123

"floatValue": 3.14, # Contains value if the data is of float type.

2124

"url": "A String", # An optional full URL.

2125

"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.

2126

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2127

},

2128

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2129

"inputCollectionName": [ # User names for all collection inputs to this transform.

2130

"A String",

2131

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2132

"id": "A String", # SDK generated id of this transform instance.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2133

"kind": "A String", # Type of transform.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2134

"outputCollectionName": [ # User names for all collection outputs to this transform.

2135

"A String",

2136

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2137

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2138

],

2139

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2140

{ # 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.

2141

"kind": "A String", # Type of tranform this stage is executing.

2142

"id": "A String", # Dataflow service generated id for this stage.

2143

"name": "A String", # Dataflow service generated name for this stage.

2144

"componentTransform": [ # Transforms that comprise this execution stage.

2145

{ # Description of a transform executed as part of an execution stage.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2146

"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]

2147

"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]

2148

"name": "A String", # Dataflow service generated name for this source.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2149

},

2150

],

2151

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

2152

{ # Description of an interstitial value between transforms in an execution stage.

2153

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

2154

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2155

"name": "A String", # Dataflow service generated name for this source.

2156

},

2157

],

2158

"outputSource": [ # Output sources for this stage.

2159

{ # Description of an input or output of an execution stage.

2160

"sizeBytes": "A String", # Size of the source, if measurable.

2161

"name": "A String", # Dataflow service generated name for this source.

2162

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2163

"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]

2164

},

2165

],

2166

"inputSource": [ # Input sources for this stage.

2167

{ # Description of an input or output of an execution stage.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2168

"sizeBytes": "A String", # Size of the source, if measurable.

2169

"name": "A String", # Dataflow service generated name for this source.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2170

"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]

2171

"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]

2172

},

2173

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2174

},

2175

],

2176

"displayData": [ # Pipeline level display data.

2177

{ # Data provided with a pipeline or transform to provide descriptive info.

2178

"durationValue": "A String", # Contains value if the data is of duration type.

2179

"javaClassValue": "A String", # Contains value if the data is of java class type.

2180

"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.

2181

"boolValue": True or False, # Contains value if the data is of a boolean type.

2182

"int64Value": "A String", # Contains value if the data is of int64 type.

2183

"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.

2184

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2185

"label": "A String", # An optional label to display in a dax UI for the element.

2186

"floatValue": 3.14, # Contains value if the data is of float type.

2187

"url": "A String", # An optional full URL.

2188

"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.

2189

"strValue": "A String", # Contains value if the data is of string type.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

2190

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2191

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2192

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2193

"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]

2194

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

2195

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2196

"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.

2197

{ # 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.

2198

"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.

2199

"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.

2200

"a_key": "", # Properties of the object.

2201

},

2202

"kind": "A String", # The kind of step in the Cloud Dataflow job.

2203

},

2204

],

2205

"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])?`

2206

"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]

2207

"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]

2208

"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.

2209

"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

2210

"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}

2211

"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}

2212

"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]

2213

"a_key": "", # Properties of the object.

2214

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2215

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

2216

{ # 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.

2217

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

2218

"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]

2219

"metadata": { # Metadata to set on the Google Compute Engine VMs.

2220

"a_key": "A String",

2221

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2222

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

2223

"poolArgs": { # Extra arguments for this worker pool.

2224

"a_key": "", # Properties of the object. Contains field @type with type URL.

2225

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2226

"ipConfiguration": "A String", # Configuration for VM IPs.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2227

"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.

2228

"packages": [ # Packages to be installed on workers.

2229

{ # 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.

2230

"name": "A String", # The name of the package.

2231

"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/

2232

},

2233

],

2234

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

2235

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

2236

"languageHint": "A String", # The suggested backend language.

2237

"workflowFileName": "A String", # The file to store the workflow in.

2238

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

2239

"vmId": "A String", # The ID string of the VM.

2240

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

2241

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

2242

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

2243

"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}

2244

"harnessCommand": "A String", # The command to launch the worker harness.

2245

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

2246

"A String",

2247

],

2248

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

2249

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

2250

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

2251

"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}

2252

"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/"

2253

"logDir": "A String", # The directory on the VM to store logs.

2254

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

2255

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

2256

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

2257

"workerId": "A String", # The ID of the worker running this pipeline.

2258

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

2259

"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/"

2260

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

2261

"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}

2262

},

2263

},

2264

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

2265

"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.

2266

{ # Defines a SDK harness container for executing Dataflow pipelines.

2267

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

2268

"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.

2269

},

2270

],

2271

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

2272

"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.

2273

"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]

2274

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

2275

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

2276

"algorithm": "A String", # The algorithm to use for autoscaling.

2277

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2278

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2279

"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).

2280

"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.

2281

"dataDisks": [ # Data disks that are used by a VM in this workflow.

2282

{ # Describes the data disk used by a workflow job.

2283

"mountPoint": "A String", # Directory in a VM where disk is mounted.

2284

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2285

"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]

2286

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2287

],

2288

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

2289

"diskSourceImage": "A String", # Fully qualified source image for disks.

2290

"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]

2291

},

2292

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2293

"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.

2294

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

2295

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

2296

"userAgent": { # A description of the process that generated the request.

2297

"a_key": "", # Properties of the object.

2298

},

2299

"experiments": [ # The list of experiments to enable.

2300

"A String",

2301

],

2302

"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.

2303

"a_key": "", # Properties of the object.

2304

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2305

"internalExperiments": { # Experimental settings.

2306

"a_key": "", # Properties of the object. Contains field @type with type URL.

2307

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2308

"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".

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2309

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2310

"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}

2311

"A String",

2312

],

2313

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

2314

"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.

2315

"currentStateTime": "A String", # The timestamp associated with the current state.

2316

"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.

2317

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2318

"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.

2319

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

2320

"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.

2321

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2322

"stages": { # A mapping from each stage to the information about that stage.

2323

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2324

"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.

2325

"A String",

2326

],

Takashi Matsuo

0669410

2015-09-11 13:55:40 -0700

[diff] [blame]

2327

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2328

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2329

},

2330

"type": "A String", # The type of Cloud Dataflow job.

2331

"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.

2332

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

2333

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

2334

"a_key": "A String",

2335

},

2336

"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.

2337

"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.

2338

"fileDetails": [ # Identification of a File source used in the Dataflow job.

2339

{ # Metadata for a File connector used by the job.

2340

"filePattern": "A String", # File Pattern used to access files by the connector.

2341

},

2342

],

2343

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

2344

{ # Metadata for a Spanner connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2345

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2346

"projectId": "A String", # ProjectId accessed in the connection.

2347

"databaseId": "A String", # DatabaseId accessed in the connection.

2348

},

2349

],

2350

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

2351

{ # Metadata for a Datastore connector used by the job.

2352

"namespace": "A String", # Namespace used in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2353

"projectId": "A String", # ProjectId accessed in the connection.

2354

},

2355

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2356

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

2357

"version": "A String", # The version of the SDK used to run the job.

2358

"sdkSupportStatus": "A String", # The support status for this SDK version.

2359

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

2360

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2361

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

2362

{ # Metadata for a PubSub connector used by the job.

2363

"subscription": "A String", # Subscription used in the connection.

2364

"topic": "A String", # Topic accessed in the connection.

2365

},

2366

],

2367

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

2368

{ # Metadata for a BigQuery connector used by the job.

2369

"dataset": "A String", # Dataset accessed in the connection.

2370

"projectId": "A String", # Project accessed in the connection.

2371

"query": "A String", # Query used to access data in the connection.

2372

"table": "A String", # Table accessed in the connection.

2373

},

2374

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2375

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

2376

{ # Metadata for a BigTable connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2377

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2378

"tableId": "A String", # TableId accessed in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

2379

"projectId": "A String", # ProjectId accessed in the connection.

2380

},

2381

],

2382

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2383

"stepsLocation": "A String", # The GCS location where the steps are stored.

2384

}</pre>

Nathaniel Manista