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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

93

<code><a href="#aggregated">aggregated(projectId, pageToken=None, location=None, pageSize=None, view=None, filter=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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

102

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

Dmitry Frenkel

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

[diff] [blame]

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

111

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

Dmitry Frenkel

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

[diff] [blame]

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

124

<code class="details" id="aggregated">aggregated(projectId, pageToken=None, location=None, pageSize=None, view=None, filter=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)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

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

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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.

Bu Sun Kim

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

[diff] [blame]

132

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

Dmitry Frenkel

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

[diff] [blame]

133

Allowed values

134

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.

135

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.

136

JOB_VIEW_ALL - Request all information available for this job.

137

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

138

filter: string, The kind of filter to use.

139

Allowed values

140

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

141

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

142

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.

143

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

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-11-16 11:05:03 -0700

[diff] [blame]

153

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

154

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

155

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

156

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

157

},

158

],

Bu Sun Kim

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

[diff] [blame]

159

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

Bu Sun Kim

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

[diff] [blame]

160

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

161

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

162

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

163

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

164

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

165

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

166

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

167

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

168

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

169

},

170

],

171

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

172

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

173

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

174

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

175

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

176

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

177

},

178

],

179

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

180

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

181

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

182

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

183

},

184

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

185

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

186

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

187

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

188

},

189

],

190

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

191

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

192

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

193

},

194

],

195

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

196

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

197

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

198

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

199

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

200

},

201

],

202

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

203

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

204

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

205

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

206

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

},

],

},

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

211

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

212

"a_key": "A String",

213

},

214

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

215

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

216

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

217

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

218

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

219

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

220

},

221

],

222

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

223

"a_key": "A String",

224

},

225

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

226

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

227

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

228

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

229

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

230

},

231

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

232

},

233

],

234

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

235

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

236

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

237

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

238

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

239

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

240

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

Dmitry Frenkel

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

[diff] [blame]

241

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

242

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

243

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

244

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

245

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

246

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

Dmitry Frenkel

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

[diff] [blame]

247

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

248

"internalExperiments": { # Experimental settings.

249

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

250

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

251

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

252

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

Dmitry Frenkel

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

[diff] [blame]

253

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

254

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

255

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

256

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

257

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

258

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

259

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

260

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

261

"a_key": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

262

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

263

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

264

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

265

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

266

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

267

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

268

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

269

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

270

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

271

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

272

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

273

"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

274

},

275

],

276

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

277

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

278

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

279

},

280

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

281

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

282

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

283

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

284

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

285

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

286

},

287

],

288

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

289

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

290

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

291

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

292

},

293

],

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

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

307

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

308

"tempStoragePrefix": "A String", # The prefix of the resources the system should use for temporary storage. The supported resource type is: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object}

309

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

310

},

311

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

312

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

313

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

314

"A String",

315

],

316

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

317

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

318

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

319

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

320

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

321

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

322

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

323

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

324

},

325

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

326

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

327

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

328

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

},

},

],

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

333

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

334

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

335

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

336

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

337

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

338

"A String",

339

],

340

"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

341

},

342

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

343

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

344

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

345

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

346

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

347

"A String",

348

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

349

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

350

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

351

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

352

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

353

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

354

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

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

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

363

},

364

],

365

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

366

"A String",

367

],

368

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

369

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

370

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

371

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

372

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

373

},

374

],

375

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

376

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

377

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

378

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

379

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

380

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

381

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

382

},

383

],

384

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

385

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

386

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

387

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

388

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

389

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

390

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

391

},

392

],

393

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

394

},

395

],

396

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

397

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

398

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

399

"A String",

400

],

401

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

402

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

403

"A String",

404

],

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

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

415

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

416

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

417

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

418

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

419

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

420

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

},

],

},

],

"displayData": [ # Pipeline level display data.

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

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

},

],

},

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

443

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

444

"A String",

445

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

446

},

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

447

],

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>

453

<pre>Retrieves the next page of results.

454

455

Args:

456

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

457

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

458

459

Returns:

Bu Sun Kim

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

[diff] [blame]

460

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]

461

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]

466

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

467

<pre>Close httplib2 connections.</pre>

468

</div>

Nathaniel Manista

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

[diff] [blame]

469

Dmitry Frenkel

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

[diff] [blame]

470

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

471

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

Dmitry Frenkel

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

[diff] [blame]

472

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

473

Nathaniel Manista

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

[diff] [blame]

474

Args:

Sai Cheemalapati

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

[diff] [blame]

475

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]

476

body: object, The request body.

Nathaniel Manista

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

[diff] [blame]

477

The object takes the form of:

478

Sai Cheemalapati

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

[diff] [blame]

479

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

480

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

481

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

482

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

483

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

484

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

485

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

486

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

487

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

488

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

489

],

490

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

491

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

492

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

493

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

494

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

495

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

496

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

497

],

498

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

499

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

500

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

501

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

502

},

503

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

504

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

505

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

506

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

507

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

508

],

509

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

510

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

511

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

512

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

513

],

514

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

515

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

516

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

517

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

518

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

519

},

520

],

521

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

522

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

523

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

524

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

525

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

526

},

527

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

528

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

529

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

Dmitry Frenkel

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

[diff] [blame]

530

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

531

"a_key": "A String",

532

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

533

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

534

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

535

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

536

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

537

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

538

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

539

},

540

],

541

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

542

"a_key": "A String",

543

},

Dmitry Frenkel

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

[diff] [blame]

544

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

545

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

546

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

547

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

548

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

549

},

550

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

551

},

552

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

553

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

554

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

555

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

556

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

557

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

558

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

559

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

560

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

561

},

562

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

563

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

564

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

565

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

566

},

567

"internalExperiments": { # Experimental settings.

568

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

569

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

570

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

571

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

572

},

573

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

574

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

575

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

576

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

577

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

578

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

579

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

580

"a_key": "A String",

581

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

582

"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-11-16 11:05:03 -0700

[diff] [blame]

583

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

584

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

585

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

586

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

587

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

588

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

589

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

590

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

591

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

592

"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-11-16 11:05:03 -0700

[diff] [blame]

593

},

594

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

595

"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-11-16 11:05:03 -0700

[diff] [blame]

596

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

597

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

598

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

599

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

600

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

601

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

602

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

603

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

604

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

605

},

606

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

607

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

608

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

609

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

610

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

611

},

612

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

613

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

614

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

615

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

616

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

617

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

618

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

619

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

620

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

621

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

622

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

623

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

624

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

625

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

626

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

627

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

628

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

629

},

630

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

631

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

632

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

633

"A String",

634

],

635

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

636

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

637

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

638

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

639

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

640

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

641

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

642

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

643

},

644

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

645

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

646

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

647

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

648

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

649

},

650

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

651

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

652

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

653

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

654

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

655

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

656

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

657

"A String",

658

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

659

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

660

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

661

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

662

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

663

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

664

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

665

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

],

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

671

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

672

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

673

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

674

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

675

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

676

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

677

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

678

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

679

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

680

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

681

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

682

},

683

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

684

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

685

"A String",

686

],

687

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

688

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

689

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

690

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

691

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

692

},

693

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

694

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

695

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

696

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

697

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

698

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

699

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

700

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

701

},

702

],

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

},

711

],

712

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

713

},

714

],

715

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

716

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

717

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

718

"A String",

719

],

720

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

721

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

722

"A String",

723

],

724

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

725

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

726

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

727

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

728

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

729

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

730

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

731

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

732

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

733

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

734

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

735

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

736

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

737

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

738

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

739

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

740

},

741

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

742

},

743

],

744

"displayData": [ # Pipeline level display data.

745

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

746

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

747

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

748

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

749

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

750

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

751

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

752

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

753

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

754

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

755

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

756

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

757

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

758

},

759

],

760

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

761

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

762

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

"A String",

],

}

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

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

770

Allowed values

771

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.

772

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.

773

JOB_VIEW_ALL - Request all information available for this job.

774

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

775

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

782

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

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

791

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

792

},

793

],

794

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

795

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

796

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

797

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

798

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

799

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

800

},

801

],

802

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

803

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

804

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

805

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

806

},

807

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

808

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

809

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

810

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

811

},

812

],

813

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

814

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

815

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

816

},

817

],

818

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

819

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

820

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

821

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

822

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

823

},

824

],

825

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

826

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

827

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

828

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

829

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

},

],

},

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

834

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

835

"a_key": "A String",

836

},

837

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

838

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

839

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

840

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

841

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

842

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

843

},

844

],

845

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

846

"a_key": "A String",

847

},

848

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

849

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

850

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

851

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

852

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

853

},

854

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

855

},

856

],

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

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

865

},

866

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

867

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

868

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

869

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

870

},

871

"internalExperiments": { # Experimental settings.

872

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

873

},

874

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

875

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

876

},

877

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

878

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

879

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

880

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

881

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

882

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

883

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

884

"a_key": "A String",

885

},

886

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

887

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

888

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

889

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

890

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

891

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

892

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

893

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

894

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

895

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

896

"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

897

},

898

],

899

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

900

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

901

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

902

},

903

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

904

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

905

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

906

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

907

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

908

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

909

},

910

],

911

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

912

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

913

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

914

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

915

},

916

],

917

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

918

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

919

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

920

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

921

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

922

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

923

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

924

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

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

},

934

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

935

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

936

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

937

"A String",

938

],

939

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

940

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

941

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

942

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

943

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

944

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

945

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

946

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

947

},

948

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

949

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

950

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

951

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

},

},

],

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

956

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

957

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

958

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

959

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

960

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

961

"A String",

962

],

963

"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

964

},

965

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

966

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

967

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

968

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

969

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

],

},

},

},

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

976

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

977

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

978

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

979

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

980

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

981

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

982

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

983

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

984

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

985

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

986

},

987

],

988

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

989

"A String",

990

],

991

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

992

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

993

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

994

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

995

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

996

},

997

],

998

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

999

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

1000

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

1001

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

1002

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

1003

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

1004

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

1005

},

1006

],

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

},

1015

],

1016

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

1017

},

1018

],

1019

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

1020

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

1021

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

1022

"A String",

1023

],

1024

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

1025

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

1026

"A String",

1027

],

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

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

1035

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

1036

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

1037

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

1038

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

1039

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

1040

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

1041

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

1042

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

1043

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

},

],

},

],

"displayData": [ # Pipeline level display data.

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

},

],

},

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

1066

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

1067

"A String",

1068

],

1069

}</pre>

Dmitry Frenkel

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

[diff] [blame]

</div>

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

1074

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

1075

1076

Args:

1077

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

1078

jobId: string, The job ID. (required)

1079

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

1080

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

1081

Allowed values

1082

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.

1083

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.

1084

JOB_VIEW_ALL - Request all information available for this job.

1085

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

1086

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1093

1094

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

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1095

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

1096

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

1097

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

1098

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

1099

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

1100

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

1101

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

1102

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

1103

},

1104

],

1105

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

1106

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

1107

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

1108

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

1109

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

1110

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

1111

},

1112

],

1113

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

1114

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

1115

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

1116

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

1117

},

1118

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

1119

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

1120

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

1121

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

1122

},

1123

],

1124

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

1125

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

1126

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

1127

},

1128

],

1129

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

1130

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

1131

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

1132

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

1133

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

1134

},

1135

],

1136

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

1137

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

1138

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

1139

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

1140

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

},

],

},

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

1145

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

1146

"a_key": "A String",

1147

},

1148

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

1149

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

1150

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

1151

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

1152

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

1153

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

1154

},

1155

],

1156

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

1157

"a_key": "A String",

1158

},

1159

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

1160

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

1161

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

1162

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

1163

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

1164

},

1165

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

1166

},

1167

],

1168

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

1169

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

1170

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

1171

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

1172

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

1173

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

1174

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

Dmitry Frenkel

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

[diff] [blame]

1175

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

1176

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1177

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

1178

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

1179

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

1180

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

Bu Sun Kim

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

[diff] [blame]

1181

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1182

"internalExperiments": { # Experimental settings.

1183

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1184

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1185

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

1186

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

Dmitry Frenkel

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

[diff] [blame]

1187

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1188

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

1189

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

1190

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

1191

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

1192

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

1193

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

1194

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

1195

"a_key": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1196

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1197

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

1198

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

1199

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

1200

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

1201

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

1202

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

1203

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

1204

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

1205

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

1206

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

1207

"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

1208

},

1209

],

1210

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

1211

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

1212

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

1213

},

1214

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

1215

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

1216

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

1217

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

1218

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

1219

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

1220

},

1221

],

1222

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

1223

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

1224

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

1225

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

1226

},

1227

],

1228

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

1229

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

1230

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

1231

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

1232

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

1233

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

1234

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

1235

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

1236

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

1237

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

1238

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

1239

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

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

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

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

},

1245

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

1246

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

1247

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

1248

"A String",

1249

],

1250

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

1251

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

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

1258

},

1259

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

1260

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

1261

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

1262

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

},

},

],

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

"A String",

1273

],

1274

"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

1275

},

1276

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

1277

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

1278

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

1279

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

1280

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1281

"A String",

1282

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1283

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1284

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1285

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1286

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

1287

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1288

"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.

1289

"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.

1290

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1291

{ # 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.

1292

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1293

{ # Description of an interstitial value between transforms in an execution stage.

1294

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1295

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1296

"name": "A String", # Dataflow service generated name for this source.

1297

},

1298

],

1299

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

1300

"A String",

1301

],

1302

"componentTransform": [ # Transforms that comprise this execution stage.

1303

{ # Description of a transform executed as part of an execution stage.

1304

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1305

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1306

"name": "A String", # Dataflow service generated name for this source.

1307

},

1308

],

1309

"name": "A String", # Dataflow service generated name for this stage.

1310

"inputSource": [ # Input sources for this stage.

1311

{ # Description of an input or output of an execution stage.

1312

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1313

"sizeBytes": "A String", # Size of the source, if measurable.

1314

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1315

"name": "A String", # Dataflow service generated name for this source.

1316

},

1317

],

1318

"id": "A String", # Dataflow service generated id for this stage.

1319

"outputSource": [ # Output sources for this stage.

1320

{ # Description of an input or output of an execution stage.

1321

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1322

"sizeBytes": "A String", # Size of the source, if measurable.

1323

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1324

"name": "A String", # Dataflow service generated name for this source.

1325

},

1326

],

1327

"kind": "A String", # Type of tranform this stage is executing.

1328

},

1329

],

1330

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1331

{ # Description of the type, names/ids, and input/outputs for a transform.

1332

"outputCollectionName": [ # User names for all collection outputs to this transform.

1333

"A String",

1334

],

1335

"name": "A String", # User provided name for this transform instance.

1336

"inputCollectionName": [ # User names for all collection inputs to this transform.

1337

"A String",

1338

],

1339

"kind": "A String", # Type of transform.

1340

"id": "A String", # SDK generated id of this transform instance.

1341

"displayData": [ # Transform-specific display data.

1342

{ # Data provided with a pipeline or transform to provide descriptive info.

1343

"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.

1344

"boolValue": True or False, # Contains value if the data is of a boolean type.

1345

"int64Value": "A String", # Contains value if the data is of int64 type.

1346

"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.

1347

"javaClassValue": "A String", # Contains value if the data is of java class type.

1348

"durationValue": "A String", # Contains value if the data is of duration type.

1349

"label": "A String", # An optional label to display in a dax UI for the element.

1350

"floatValue": 3.14, # Contains value if the data is of float type.

1351

"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.

1352

"strValue": "A String", # Contains value if the data is of string type.

1353

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1354

"url": "A String", # An optional full URL.

},

],

},

],

"displayData": [ # Pipeline level display data.

1360

{ # Data provided with a pipeline or transform to provide descriptive info.

1361

"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.

1362

"boolValue": True or False, # Contains value if the data is of a boolean type.

1363

"int64Value": "A String", # Contains value if the data is of int64 type.

1364

"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.

1365

"javaClassValue": "A String", # Contains value if the data is of java class type.

1366

"durationValue": "A String", # Contains value if the data is of duration type.

1367

"label": "A String", # An optional label to display in a dax UI for the element.

1368

"floatValue": 3.14, # Contains value if the data is of float type.

1369

"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.

1370

"strValue": "A String", # Contains value if the data is of string type.

1371

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1372

"url": "A String", # An optional full URL.

},

],

},

"type": "A String", # The type of Cloud Dataflow job.

1377

"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}

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1378

"A String",

1379

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1380

}</pre>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1384

<code class="details" id="getMetrics">getMetrics(projectId, jobId, startTime=None, location=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1385

<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]

1386

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1387

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1388

projectId: string, A project id. (required)

1389

jobId: string, The job to get metrics for. (required)

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1390

startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1391

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]

1392

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1393

Allowed values

1394

1 - v1 error format

1395

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1396

1397

Returns:

1398

An object of the form:

1399

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1400

{ # 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.

1401

"metrics": [ # All metrics for this job.

1402

{ # Describes the state of a metric.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1403

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1404

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1405

"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.

1406

"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.

1407

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1408

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1409

"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.

1410

"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.

1411

"distribution": "", # A struct value describing properties of a distribution of numeric values.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1412

"name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1413

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1414

"name": "A String", # Worker-defined metric name.

1415

"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]

1416

"a_key": "A String",

1417

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1419

"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

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1420

},

1421

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1422

"metricTime": "A String", # Timestamp as of which metric values are current.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1427

<code class="details" id="list">list(projectId, location=None, pageSize=None, filter=None, view=None, pageToken=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1428

<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`.

1429

1430

Args:

1431

projectId: string, The project which owns the jobs. (required)

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1432

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1433

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.

1434

filter: string, The kind of filter to use.

1435

Allowed values

1436

UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`.

1437

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.

1438

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.

1439

ACTIVE - Filters the jobs that are running ordered on the creation timestamp.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1440

view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.

1441

Allowed values

1442

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.

1443

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.

1444

JOB_VIEW_ALL - Request all information available for this job.

1445

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1446

pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1447

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1454

1455

{ # 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-11-16 11:05:03 -0700

[diff] [blame]

1456

"nextPageToken": "A String", # Set if there may be more results than fit in this response.

1457

"failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1458

{ # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

1459

"name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1460

},

1461

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1462

"jobs": [ # A subset of the requested job information.

1463

{ # Defines a job to be run by the Cloud Dataflow service.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1464

"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.

1465

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1466

"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.

1467

"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.

1468

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1469

{ # Metadata for a Datastore connector used by the job.

1470

"projectId": "A String", # ProjectId accessed in the connection.

1471

"namespace": "A String", # Namespace used in the connection.

1472

},

1473

],

1474

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1475

{ # Metadata for a BigQuery connector used by the job.

1476

"projectId": "A String", # Project accessed in the connection.

1477

"table": "A String", # Table accessed in the connection.

1478

"dataset": "A String", # Dataset accessed in the connection.

1479

"query": "A String", # Query used to access data in the connection.

1480

},

1481

],

1482

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1483

"version": "A String", # The version of the SDK used to run the job.

1484

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1485

"sdkSupportStatus": "A String", # The support status for this SDK version.

1486

},

1487

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1488

{ # Metadata for a PubSub connector used by the job.

1489

"topic": "A String", # Topic accessed in the connection.

1490

"subscription": "A String", # Subscription used in the connection.

1491

},

1492

],

1493

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1494

{ # Metadata for a File connector used by the job.

1495

"filePattern": "A String", # File Pattern used to access files by the connector.

1496

},

1497

],

1498

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1499

{ # Metadata for a BigTable connector used by the job.

1500

"projectId": "A String", # ProjectId accessed in the connection.

1501

"instanceId": "A String", # InstanceId accessed in the connection.

1502

"tableId": "A String", # TableId accessed in the connection.

1503

},

1504

],

1505

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1506

{ # Metadata for a Spanner connector used by the job.

1507

"instanceId": "A String", # InstanceId accessed in the connection.

1508

"projectId": "A String", # ProjectId accessed in the connection.

1509

"databaseId": "A String", # DatabaseId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

1514

"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.

1515

"a_key": "A String",

1516

},

1517

"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.

1518

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1519

{ # A message describing the state of a particular execution stage.

1520

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1521

"executionStageName": "A String", # The name of the execution stage.

1522

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1523

},

1524

],

1525

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1526

"a_key": "A String",

1527

},

1528

"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.

1529

{ # 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.

1530

"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.

1531

"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.

1532

"a_key": "", # Properties of the object.

1533

},

1534

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1535

},

1536

],

1537

"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.

1538

"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])?`

1539

"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.

1540

"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.

1541

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1542

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1543

"userAgent": { # A description of the process that generated the request.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1544

"a_key": "", # Properties of the object.

1545

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1546

"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".

1547

"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}

1548

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1549

"a_key": "", # Properties of the object.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1550

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1551

"internalExperiments": { # Experimental settings.

1552

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1553

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1554

"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.

1555

"a_key": "", # Properties of the object.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1556

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1557

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1558

{ # 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.

1559

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1560

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1561

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1562

"ipConfiguration": "A String", # Configuration for VM IPs.

1563

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1564

"a_key": "A String",

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1565

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1566

"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.

1567

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1568

"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.

1569

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1570

"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.

1571

"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).

1572

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1573

{ # Describes the data disk used by a workflow job.

1574

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1575

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1576

"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

1577

},

1578

],

1579

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1580

"poolArgs": { # Extra arguments for this worker pool.

1581

"a_key": "", # Properties of the object. Contains field @type with type URL.

1582

},

1583

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1584

"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.

1585

"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.

1586

{ # Defines a SDK harness container for executing Dataflow pipelines.

1587

"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.

1588

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1589

},

1590

],

1591

"packages": [ # Packages to be installed on workers.

1592

{ # 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.

1593

"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/

1594

"name": "A String", # The name of the package.

1595

},

1596

],

1597

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1598

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1599

"vmId": "A String", # The ID string of the VM.

1600

"languageHint": "A String", # The suggested backend language.

1601

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1602

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1603

"workflowFileName": "A String", # The file to store the workflow in.

1604

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1605

"logDir": "A String", # The directory on the VM to store logs.

1606

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1607

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1608

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1609

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1610

"workerId": "A String", # The ID of the worker running this pipeline.

1611

"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}

1612

"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/"

1613

},

1614

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1615

"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/"

1616

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1617

"A String",

1618

],

1619

"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}

1620

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1621

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1622

"harnessCommand": "A String", # The command to launch the worker harness.

1623

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1624

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1625

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1626

"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}

1627

},

1628

"diskSourceImage": "A String", # Fully qualified source image for disks.

1629

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1630

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1631

"algorithm": "A String", # The algorithm to use for autoscaling.

},

},

],

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1636

"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.

1637

"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}

1638

"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.

1639

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1640

"experiments": [ # The list of experiments to enable.

1641

"A String",

1642

],

1643

"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

1644

},

1645

"currentStateTime": "A String", # The timestamp associated with the current state.

1646

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1647

"stages": { # A mapping from each stage to the information about that stage.

1648

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1649

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1650

"A String",

1651

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1652

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1653

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1654

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1655

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

1656

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1657

"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.

1658

"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.

1659

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1660

{ # 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.

1661

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1662

{ # Description of an interstitial value between transforms in an execution stage.

1663

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1664

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1665

"name": "A String", # Dataflow service generated name for this source.

1666

},

1667

],

1668

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

1669

"A String",

1670

],

1671

"componentTransform": [ # Transforms that comprise this execution stage.

1672

{ # Description of a transform executed as part of an execution stage.

1673

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1674

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1675

"name": "A String", # Dataflow service generated name for this source.

1676

},

1677

],

1678

"name": "A String", # Dataflow service generated name for this stage.

1679

"inputSource": [ # Input sources for this stage.

1680

{ # Description of an input or output of an execution stage.

1681

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1682

"sizeBytes": "A String", # Size of the source, if measurable.

1683

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1684

"name": "A String", # Dataflow service generated name for this source.

1685

},

1686

],

1687

"id": "A String", # Dataflow service generated id for this stage.

1688

"outputSource": [ # Output sources for this stage.

1689

{ # Description of an input or output of an execution stage.

1690

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1691

"sizeBytes": "A String", # Size of the source, if measurable.

1692

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1693

"name": "A String", # Dataflow service generated name for this source.

1694

},

1695

],

1696

"kind": "A String", # Type of tranform this stage is executing.

1697

},

1698

],

1699

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1700

{ # Description of the type, names/ids, and input/outputs for a transform.

1701

"outputCollectionName": [ # User names for all collection outputs to this transform.

1702

"A String",

1703

],

1704

"name": "A String", # User provided name for this transform instance.

1705

"inputCollectionName": [ # User names for all collection inputs to this transform.

1706

"A String",

1707

],

1708

"kind": "A String", # Type of transform.

1709

"id": "A String", # SDK generated id of this transform instance.

1710

"displayData": [ # Transform-specific display data.

1711

{ # Data provided with a pipeline or transform to provide descriptive info.

1712

"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.

1713

"boolValue": True or False, # Contains value if the data is of a boolean type.

1714

"int64Value": "A String", # Contains value if the data is of int64 type.

1715

"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.

1716

"javaClassValue": "A String", # Contains value if the data is of java class type.

1717

"durationValue": "A String", # Contains value if the data is of duration type.

1718

"label": "A String", # An optional label to display in a dax UI for the element.

1719

"floatValue": 3.14, # Contains value if the data is of float type.

1720

"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.

1721

"strValue": "A String", # Contains value if the data is of string type.

1722

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1723

"url": "A String", # An optional full URL.

},

],

},

],

"displayData": [ # Pipeline level display data.

1729

{ # Data provided with a pipeline or transform to provide descriptive info.

1730

"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.

1731

"boolValue": True or False, # Contains value if the data is of a boolean type.

1732

"int64Value": "A String", # Contains value if the data is of int64 type.

1733

"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.

1734

"javaClassValue": "A String", # Contains value if the data is of java class type.

1735

"durationValue": "A String", # Contains value if the data is of duration type.

1736

"label": "A String", # An optional label to display in a dax UI for the element.

1737

"floatValue": 3.14, # Contains value if the data is of float type.

1738

"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.

1739

"strValue": "A String", # Contains value if the data is of string type.

1740

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1741

"url": "A String", # An optional full URL.

},

],

},

"type": "A String", # The type of Cloud Dataflow job.

1746

"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}

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1747

"A String",

1748

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1749

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1750

],

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>

1756

<pre>Retrieves the next page of results.

1757

1758

Args:

1759

previous_request: The request for the previous page. (required)

1760

previous_response: The response from the request for the previous page. (required)

1761

1762

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1763

A request object that you can call 'execute()' on to request the next

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1764

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]

1769

<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]

1770

<pre>Snapshot the state of a streaming job.

1771

1772

Args:

1773

projectId: string, The project which owns the job to be snapshotted. (required)

1774

jobId: string, The job to be snapshotted. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1775

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1776

The object takes the form of:

1777

1778

{ # Request to create a snapshot of a job.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1779

"description": "A String", # User specified description of the snapshot. Maybe empty.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1780

"ttl": "A String", # TTL for the snapshot.

1781

"location": "A String", # The location that contains this job.

1782

"snapshotSources": True or False, # If true, perform snapshots for sources which support this.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1783

}

1784

1785

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1792

1793

{ # Represents a snapshot of a job.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1794

"ttl": "A String", # The time after which this snapshot will be automatically deleted.

1795

"sourceJobId": "A String", # The job this snapshot was created from.

1796

"description": "A String", # User specified description of the snapshot. Maybe empty.

1797

"projectId": "A String", # The project this snapshot belongs to.

1798

"id": "A String", # The unique ID of this snapshot.

1799

"state": "A String", # State of the snapshot.

1800

"creationTime": "A String", # The time this snapshot was created.

1801

"diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY state.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1802

"pubsubMetadata": [ # PubSub snapshot metadata.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1803

{ # Represents a Pubsub snapshot.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1804

"snapshotName": "A String", # The name of the Pubsub snapshot.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1805

"expireTime": "A String", # The expire time of the Pubsub snapshot.

1806

"topicName": "A String", # The name of the Pubsub topic.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1807

},

1808

],

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]

1813

<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]

1814

<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]

1815

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1816

Args:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1817

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

1818

jobId: string, The job ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1819

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1820

The object takes the form of:

1821

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1822

{ # Defines a job to be run by the Cloud Dataflow service.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1823

"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.

1824

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1825

"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.

1826

"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.

1827

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1828

{ # Metadata for a Datastore connector used by the job.

1829

"projectId": "A String", # ProjectId accessed in the connection.

1830

"namespace": "A String", # Namespace used in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1831

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1832

],

1833

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1834

{ # Metadata for a BigQuery connector used by the job.

1835

"projectId": "A String", # Project accessed in the connection.

1836

"table": "A String", # Table accessed in the connection.

1837

"dataset": "A String", # Dataset accessed in the connection.

1838

"query": "A String", # Query used to access data in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1839

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1840

],

1841

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1842

"version": "A String", # The version of the SDK used to run the job.

1843

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1844

"sdkSupportStatus": "A String", # The support status for this SDK version.

1845

},

1846

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1847

{ # Metadata for a PubSub connector used by the job.

1848

"topic": "A String", # Topic accessed in the connection.

1849

"subscription": "A String", # Subscription used in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1850

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1851

],

1852

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1853

{ # Metadata for a File connector used by the job.

1854

"filePattern": "A String", # File Pattern used to access files by the connector.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1855

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1856

],

1857

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1858

{ # Metadata for a BigTable connector used by the job.

1859

"projectId": "A String", # ProjectId accessed in the connection.

1860

"instanceId": "A String", # InstanceId accessed in the connection.

1861

"tableId": "A String", # TableId accessed in the connection.

1862

},

1863

],

1864

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1865

{ # Metadata for a Spanner connector used by the job.

1866

"instanceId": "A String", # InstanceId accessed in the connection.

1867

"projectId": "A String", # ProjectId accessed in the connection.

1868

"databaseId": "A String", # DatabaseId accessed in the connection.

1869

},

1870

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1871

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1872

"stepsLocation": "A String", # The GCS location where the steps are stored.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1873

"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]

1874

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1875

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1876

"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.

1877

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1878

{ # A message describing the state of a particular execution stage.

1879

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1880

"executionStageName": "A String", # The name of the execution stage.

1881

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1882

},

1883

],

1884

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1885

"a_key": "A String",

1886

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1887

"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.

1888

{ # 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.

1889

"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.

1890

"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.

1891

"a_key": "", # Properties of the object.

1892

},

1893

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1894

},

1895

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1896

"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.

1897

"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])?`

1898

"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.

1899

"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.

1900

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1901

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1902

"userAgent": { # A description of the process that generated the request.

1903

"a_key": "", # Properties of the object.

1904

},

1905

"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".

1906

"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}

1907

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1908

"a_key": "", # Properties of the object.

1909

},

1910

"internalExperiments": { # Experimental settings.

1911

"a_key": "", # Properties of the object. Contains field @type with type URL.

1912

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1913

"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.

1914

"a_key": "", # Properties of the object.

1915

},

1916

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1917

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1918

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1919

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1920

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1921

"ipConfiguration": "A String", # Configuration for VM IPs.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1922

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1923

"a_key": "A String",

1924

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1925

"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-11-16 11:05:03 -0700

[diff] [blame]

1926

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1927

"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.

1928

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1929

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1930

"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).

1931

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1932

{ # Describes the data disk used by a workflow job.

1933

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1934

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1935

"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-11-16 11:05:03 -0700

[diff] [blame]

1936

},

1937

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1938

"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-11-16 11:05:03 -0700

[diff] [blame]

1939

"poolArgs": { # Extra arguments for this worker pool.

1940

"a_key": "", # Properties of the object. Contains field @type with type URL.

1941

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1942

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1943

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1944

"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.

1945

{ # Defines a SDK harness container for executing Dataflow pipelines.

1946

"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.

1947

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1948

},

1949

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1950

"packages": [ # Packages to be installed on workers.

1951

{ # 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.

1952

"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/

1953

"name": "A String", # The name of the package.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1954

},

1955

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1956

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1957

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1958

"vmId": "A String", # The ID string of the VM.

1959

"languageHint": "A String", # The suggested backend language.

1960

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1961

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1962

"workflowFileName": "A String", # The file to store the workflow in.

1963

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1964

"logDir": "A String", # The directory on the VM to store logs.

1965

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1966

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1967

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1968

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1969

"workerId": "A String", # The ID of the worker running this pipeline.

1970

"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}

1971

"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/"

1972

},

1973

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1974

"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/"

1975

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1976

"A String",

1977

],

1978

"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}

1979

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1980

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1981

"harnessCommand": "A String", # The command to launch the worker harness.

1982

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1983

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1984

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1985

"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}

1986

},

1987

"diskSourceImage": "A String", # Fully qualified source image for disks.

1988

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1989

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1990

"algorithm": "A String", # The algorithm to use for autoscaling.

1991

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1992

},

1993

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1994

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1995

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1996

"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}

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1997

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

1998

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

1999

"experiments": [ # The list of experiments to enable.

2000

"A String",

2001

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2002

"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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2003

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2004

"currentStateTime": "A String", # The timestamp associated with the current state.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2005

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2006

"stages": { # A mapping from each stage to the information about that stage.

2007

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2008

"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",

],

},

},

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2014

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

2015

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2016

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2017

"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.

2018

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

2019

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2020

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

2021

{ # Description of an interstitial value between transforms in an execution stage.

2022

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

2023

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2024

"name": "A String", # Dataflow service generated name for this source.

2025

},

2026

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2027

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

2028

"A String",

2029

],

2030

"componentTransform": [ # Transforms that comprise this execution stage.

2031

{ # Description of a transform executed as part of an execution stage.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2032

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

2033

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2034

"name": "A String", # Dataflow service generated name for this source.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2035

},

2036

],

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2037

"name": "A String", # Dataflow service generated name for this stage.

2038

"inputSource": [ # Input sources for this stage.

2039

{ # Description of an input or output of an execution stage.

2040

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2041

"sizeBytes": "A String", # Size of the source, if measurable.

2042

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2043

"name": "A String", # Dataflow service generated name for this source.

2044

},

2045

],

2046

"id": "A String", # Dataflow service generated id for this stage.

2047

"outputSource": [ # Output sources for this stage.

2048

{ # Description of an input or output of an execution stage.

2049

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2050

"sizeBytes": "A String", # Size of the source, if measurable.

2051

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2052

"name": "A String", # Dataflow service generated name for this source.

2053

},

2054

],

2055

"kind": "A String", # Type of tranform this stage is executing.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2056

},

2057

],

2058

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

2059

{ # Description of the type, names/ids, and input/outputs for a transform.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2060

"outputCollectionName": [ # User names for all collection outputs to this transform.

2061

"A String",

2062

],

2063

"name": "A String", # User provided name for this transform instance.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2064

"inputCollectionName": [ # User names for all collection inputs to this transform.

2065

"A String",

2066

],

2067

"kind": "A String", # Type of transform.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2068

"id": "A String", # SDK generated id of this transform instance.

2069

"displayData": [ # Transform-specific display data.

2070

{ # Data provided with a pipeline or transform to provide descriptive info.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2071

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2072

"boolValue": True or False, # Contains value if the data is of a boolean type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2073

"int64Value": "A String", # Contains value if the data is of int64 type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2074

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2075

"javaClassValue": "A String", # Contains value if the data is of java class type.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2076

"durationValue": "A String", # Contains value if the data is of duration type.

2077

"label": "A String", # An optional label to display in a dax UI for the element.

2078

"floatValue": 3.14, # Contains value if the data is of float type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2079

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2080

"strValue": "A String", # Contains value if the data is of string type.

2081

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2082

"url": "A String", # An optional full URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2083

},

2084

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2085

},

2086

],

2087

"displayData": [ # Pipeline level display data.

2088

{ # Data provided with a pipeline or transform to provide descriptive info.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2089

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2090

"boolValue": True or False, # Contains value if the data is of a boolean type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2091

"int64Value": "A String", # Contains value if the data is of int64 type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2092

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2093

"javaClassValue": "A String", # Contains value if the data is of java class type.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2094

"durationValue": "A String", # Contains value if the data is of duration type.

2095

"label": "A String", # An optional label to display in a dax UI for the element.

2096

"floatValue": 3.14, # Contains value if the data is of float type.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2097

"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.

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2098

"strValue": "A String", # Contains value if the data is of string type.

2099

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2100

"url": "A String", # An optional full URL.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame]

2101

},

2102

],

2103

},

Yoshi Automation Bot

2020-11-24 15:48:03 -0800

[diff] [blame^]

2104

"type": "A String", # The type of Cloud Dataflow job.

2105

"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}

"A String",

],

}

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2111

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2118

2119

{ # Defines a job to be run by the Cloud Dataflow service.

2120

"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.

2121

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

2122

"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.

2123

"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.

2124

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

2125

{ # Metadata for a Datastore connector used by the job.

2126

"projectId": "A String", # ProjectId accessed in the connection.

2127

"namespace": "A String", # Namespace used in the connection.

2128

},

2129

],

2130

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

2131

{ # Metadata for a BigQuery connector used by the job.

2132

"projectId": "A String", # Project accessed in the connection.

2133

"table": "A String", # Table accessed in the connection.

2134

"dataset": "A String", # Dataset accessed in the connection.

2135

"query": "A String", # Query used to access data in the connection.

2136

},

2137

],

2138

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

2139

"version": "A String", # The version of the SDK used to run the job.

2140

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

2141

"sdkSupportStatus": "A String", # The support status for this SDK version.

2142

},

2143

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

2144

{ # Metadata for a PubSub connector used by the job.

2145

"topic": "A String", # Topic accessed in the connection.

2146

"subscription": "A String", # Subscription used in the connection.

2147

},

2148

],

2149

"fileDetails": [ # Identification of a File source used in the Dataflow job.

2150

{ # Metadata for a File connector used by the job.

2151

"filePattern": "A String", # File Pattern used to access files by the connector.

2152

},

2153

],

2154

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

2155

{ # Metadata for a BigTable connector used by the job.

2156

"projectId": "A String", # ProjectId accessed in the connection.

2157

"instanceId": "A String", # InstanceId accessed in the connection.

2158

"tableId": "A String", # TableId accessed in the connection.

2159

},

2160

],

2161

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

2162

{ # Metadata for a Spanner connector used by the job.

2163

"instanceId": "A String", # InstanceId accessed in the connection.

2164

"projectId": "A String", # ProjectId accessed in the connection.

2165

"databaseId": "A String", # DatabaseId accessed in the connection.

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

2170

"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.

2171

"a_key": "A String",

2172

},

2173

"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.

2174

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

2175

{ # A message describing the state of a particular execution stage.

2176

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

2177

"executionStageName": "A String", # The name of the execution stage.

2178

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

2179

},

2180

],

2181

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

2182

"a_key": "A String",

2183

},

2184

"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.

2185

{ # 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.

2186

"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.

2187

"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.

2188

"a_key": "", # Properties of the object.

2189

},

2190

"kind": "A String", # The kind of step in the Cloud Dataflow job.

2191

},

2192

],

2193

"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.

2194

"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])?`

2195

"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.

2196

"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.

2197

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

2198

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

2199

"userAgent": { # A description of the process that generated the request.

2200

"a_key": "", # Properties of the object.

2201

},

2202

"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".

2203

"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}

2204

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

2205

"a_key": "", # Properties of the object.

2206

},

2207

"internalExperiments": { # Experimental settings.

2208

"a_key": "", # Properties of the object. Contains field @type with type URL.

2209

},

2210

"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.

2211

"a_key": "", # Properties of the object.

2212

},

2213

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

2214

{ # 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.

2215

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2216

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

2217

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

2218

"ipConfiguration": "A String", # Configuration for VM IPs.

2219

"metadata": { # Metadata to set on the Google Compute Engine VMs.

2220

"a_key": "A String",

2221

},

2222

"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.

2223

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

2224

"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.

2225

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

2226

"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.

2227

"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).

2228

"dataDisks": [ # Data disks that are used by a VM in this workflow.

2229

{ # Describes the data disk used by a workflow job.

2230

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2231

"mountPoint": "A String", # Directory in a VM where disk is mounted.

2232

"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

2233

},

2234

],

2235

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

2236

"poolArgs": { # Extra arguments for this worker pool.

2237

"a_key": "", # Properties of the object. Contains field @type with type URL.

2238

},

2239

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

2240

"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.

2241

"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.

2242

{ # Defines a SDK harness container for executing Dataflow pipelines.

2243

"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.

2244

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

2245

},

2246

],

2247

"packages": [ # Packages to be installed on workers.

2248

{ # 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.

2249

"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/

2250

"name": "A String", # The name of the package.

2251

},

2252

],

2253

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

2254

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

2255

"vmId": "A String", # The ID string of the VM.

2256

"languageHint": "A String", # The suggested backend language.

2257

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

2258

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

2259

"workflowFileName": "A String", # The file to store the workflow in.

2260

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

2261

"logDir": "A String", # The directory on the VM to store logs.

2262

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

2263

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

2264

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

2265

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

2266

"workerId": "A String", # The ID of the worker running this pipeline.

2267

"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}

2268

"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/"

2269

},

2270

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

2271

"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/"

2272

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

2273

"A String",

2274

],

2275

"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}

2276

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

2277

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

2278

"harnessCommand": "A String", # The command to launch the worker harness.

2279

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

2280

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

2281

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

2282

"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}

2283

},

2284

"diskSourceImage": "A String", # Fully qualified source image for disks.

2285

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

2286

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

2287

"algorithm": "A String", # The algorithm to use for autoscaling.

},

},

],

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

2292

"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.

2293

"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}

2294

"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.

2295

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

2296

"experiments": [ # The list of experiments to enable.

2297

"A String",

2298

],

2299

"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

2300

},

2301

"currentStateTime": "A String", # The timestamp associated with the current state.

2302

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2303

"stages": { # A mapping from each stage to the information about that stage.

2304

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2305

"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",

],

},

},

},

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

2312

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2313

"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.

2314

"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.

2315

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

2316

{ # 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.

2317

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

2318

{ # Description of an interstitial value between transforms in an execution stage.

2319

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

2320

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2321

"name": "A String", # Dataflow service generated name for this source.

2322

},

2323

],

2324

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

2325

"A String",

2326

],

2327

"componentTransform": [ # Transforms that comprise this execution stage.

2328

{ # Description of a transform executed as part of an execution stage.

2329

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

2330

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

2331

"name": "A String", # Dataflow service generated name for this source.

2332

},

2333

],

2334

"name": "A String", # Dataflow service generated name for this stage.

2335

"inputSource": [ # Input sources for this stage.

2336

{ # Description of an input or output of an execution stage.

2337

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2338

"sizeBytes": "A String", # Size of the source, if measurable.

2339

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2340

"name": "A String", # Dataflow service generated name for this source.

2341

},

2342

],

2343

"id": "A String", # Dataflow service generated id for this stage.

2344

"outputSource": [ # Output sources for this stage.

2345

{ # Description of an input or output of an execution stage.

2346

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2347

"sizeBytes": "A String", # Size of the source, if measurable.

2348

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2349

"name": "A String", # Dataflow service generated name for this source.

2350

},

2351

],

2352

"kind": "A String", # Type of tranform this stage is executing.

2353

},

2354

],

2355

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

2356

{ # Description of the type, names/ids, and input/outputs for a transform.

2357

"outputCollectionName": [ # User names for all collection outputs to this transform.

2358

"A String",

2359

],

2360

"name": "A String", # User provided name for this transform instance.

2361

"inputCollectionName": [ # User names for all collection inputs to this transform.

2362

"A String",

2363

],

2364

"kind": "A String", # Type of transform.

2365

"id": "A String", # SDK generated id of this transform instance.

2366

"displayData": [ # Transform-specific display data.

2367

{ # Data provided with a pipeline or transform to provide descriptive info.

2368

"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.

2369

"boolValue": True or False, # Contains value if the data is of a boolean type.

2370

"int64Value": "A String", # Contains value if the data is of int64 type.

2371

"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.

2372

"javaClassValue": "A String", # Contains value if the data is of java class type.

2373

"durationValue": "A String", # Contains value if the data is of duration type.

2374

"label": "A String", # An optional label to display in a dax UI for the element.

2375

"floatValue": 3.14, # Contains value if the data is of float type.

2376

"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.

2377

"strValue": "A String", # Contains value if the data is of string type.

2378

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2379

"url": "A String", # An optional full URL.

},

],

},

],

"displayData": [ # Pipeline level display data.

2385

{ # Data provided with a pipeline or transform to provide descriptive info.

2386

"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.

2387

"boolValue": True or False, # Contains value if the data is of a boolean type.

2388

"int64Value": "A String", # Contains value if the data is of int64 type.

2389

"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.

2390

"javaClassValue": "A String", # Contains value if the data is of java class type.

2391

"durationValue": "A String", # Contains value if the data is of duration type.

2392

"label": "A String", # An optional label to display in a dax UI for the element.

2393

"floatValue": 3.14, # Contains value if the data is of float type.

2394

"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.

2395

"strValue": "A String", # Contains value if the data is of string type.

2396

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2397

"url": "A String", # An optional full URL.

},

],

},

"type": "A String", # The type of Cloud Dataflow job.

2402

"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}

2403

"A String",

2404

],

2405

}</pre>

Nathaniel Manista