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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Sai Cheemalapati

4ba8c23

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

[diff] [blame]

78

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

79

</p>

80

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

81

82

Jon Wayne Parrott

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

[diff] [blame]

83

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

84

</p>

85

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

86

87

Bu Sun Kim

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

[diff] [blame]

88

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

89

</p>

90

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

91

92

Dmitry Frenkel

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

[diff] [blame]

93

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

94

</p>

95

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

96

97

Jon Wayne Parrott

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

[diff] [blame]

98

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

99

</p>

100

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

101

102

Dmitry Frenkel

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

[diff] [blame]

103

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

104

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

105

Bu Sun Kim

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

[diff] [blame^]

106

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

Dmitry Frenkel

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

[diff] [blame]

107

<p class="firstline">Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`.</p>

Jon Wayne Parrott

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

[diff] [blame]

108

Bu Sun Kim

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

[diff] [blame]

109

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

Dmitry Frenkel

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

[diff] [blame]

110

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

111

Bu Sun Kim

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

[diff] [blame^]

112

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

Dmitry Frenkel

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

[diff] [blame]

113

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

114

115

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

116

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

Jon Wayne Parrott

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

[diff] [blame]

117

118

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

Dmitry Frenkel

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

[diff] [blame]

119

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

Jon Wayne Parrott

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

[diff] [blame]

120

Bu Sun Kim

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

[diff] [blame^]

121

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

Dmitry Frenkel

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

[diff] [blame]

122

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

Jon Wayne Parrott

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

[diff] [blame]

123

124

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

125

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

126

Dan O'Meara

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

[diff] [blame]

127

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

Bu Sun Kim

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

[diff] [blame]

128

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

129

Dan O'Meara

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

[diff] [blame]

130

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

Dmitry Frenkel

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

[diff] [blame]

131

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

Jon Wayne Parrott

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

[diff] [blame]

132

<h3>Method Details</h3>

133

Dmitry Frenkel

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

[diff] [blame]

134

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

135

<pre>Close httplib2 connections.</pre>

136

</div>

Jon Wayne Parrott

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

[diff] [blame]

137

Dmitry Frenkel

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

[diff] [blame]

138

Bu Sun Kim

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

[diff] [blame^]

139

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

Dmitry Frenkel

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

[diff] [blame]

140

<pre>Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`.

Bu Sun Kim

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

[diff] [blame]

141

Jon Wayne Parrott

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

[diff] [blame]

142

Args:

Sai Cheemalapati

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

[diff] [blame]

143

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

Dmitry Frenkel

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

[diff] [blame]

144

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

Dan O'Meara

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

[diff] [blame]

145

body: object, The request body.

Jon Wayne Parrott

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

[diff] [blame]

146

The object takes the form of:

147

Sai Cheemalapati

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

[diff] [blame]

148

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

Dmitry Frenkel

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

[diff] [blame]

149

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

150

"a_key": "A String",

151

},

152

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

153

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

154

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

155

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

156

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

157

},

158

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

159

},

160

],

Dmitry Frenkel

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

[diff] [blame]

161

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

Dmitry Frenkel

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

[diff] [blame]

162

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

163

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

164

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

165

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

166

},

167

],

168

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

169

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

170

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

Dmitry Frenkel

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

[diff] [blame]

171

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

Bu Sun Kim

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

[diff] [blame^]

172

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

173

},

174

],

175

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

176

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

177

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

178

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

179

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

Dmitry Frenkel

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

[diff] [blame]

180

},

181

],

182

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

183

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

Dmitry Frenkel

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

[diff] [blame]

184

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

Bu Sun Kim

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

[diff] [blame^]

185

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

Dmitry Frenkel

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

[diff] [blame]

186

},

187

],

Dmitry Frenkel

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

[diff] [blame]

188

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

189

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

190

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

191

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

192

},

193

],

Bu Sun Kim

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

[diff] [blame^]

194

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

195

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

196

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

197

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

198

},

Dmitry Frenkel

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

[diff] [blame]

199

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

200

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

Dmitry Frenkel

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

[diff] [blame]

201

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

202

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

Bu Sun Kim

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

[diff] [blame^]

203

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

204

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

Dmitry Frenkel

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

[diff] [blame]

},

],

},

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

Bu Sun Kim

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

[diff] [blame^]

209

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

210

"a_key": "A String",

211

},

212

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

213

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

214

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

215

"A String",

216

],

217

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

218

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

219

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

220

},

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

},

233

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

234

"a_key": "A String",

235

},

236

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

237

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

238

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

239

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

240

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

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

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

249

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

250

},

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

"A String",

259

],

260

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

261

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

262

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

263

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

264

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

265

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

266

},

267

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

268

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

269

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

270

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

271

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

272

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

273

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

274

},

275

],

276

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

277

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

278

},

279

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

280

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

281

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

282

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

283

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

284

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

285

},

286

],

287

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

288

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

289

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

290

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

291

"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

292

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

293

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

294

},

295

],

296

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

297

},

298

],

299

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

300

"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

301

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

302

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

303

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

304

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

305

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

306

"internalExperiments": { # Experimental settings.

307

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

308

},

309

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

310

"A String",

311

],

312

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

313

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

314

},

315

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

316

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

317

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

318

},

319

},

320

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

321

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

322

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

323

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

],

},

},

},

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

330

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

331

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

332

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

333

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

334

},

335

],

336

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

337

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

338

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

339

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

340

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

341

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

342

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

343

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

344

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

345

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

346

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

347

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

348

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

349

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

350

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

351

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

352

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

353

},

354

],

355

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

356

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

357

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

358

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

359

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

360

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

361

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

362

},

363

],

364

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

365

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

366

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

367

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

368

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

369

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

370

},

371

],

372

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

373

"A String",

374

],

375

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

376

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

377

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

378

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

379

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

},

],

},

],

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

385

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

386

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

387

"A String",

388

],

389

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

390

"A String",

391

],

392

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

393

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

394

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

395

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

396

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

397

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

398

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

399

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

400

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

401

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

402

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

403

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

404

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

405

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

406

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

407

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

408

},

409

],

410

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

411

},

412

],

413

"displayData": [ # Pipeline level display data.

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

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

424

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

425

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

426

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

},

],

},

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

431

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

432

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

433

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

Dmitry Frenkel

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

[diff] [blame]

434

}

435

Bu Sun Kim

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

[diff] [blame^]

436

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

Dmitry Frenkel

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

[diff] [blame]

437

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

438

Allowed values

439

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.

440

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.

441

JOB_VIEW_ALL - Request all information available for this job.

442

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

Dmitry Frenkel

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

[diff] [blame]

443

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

450

451

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

Dmitry Frenkel

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

[diff] [blame]

452

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

453

"a_key": "A String",

Jon Wayne Parrott

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

[diff] [blame]

454

},

Dmitry Frenkel

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

[diff] [blame]

455

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

456

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

457

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

458

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

459

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

460

},

461

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

462

},

463

],

Dmitry Frenkel

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

[diff] [blame]

464

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

Dmitry Frenkel

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

[diff] [blame]

465

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

466

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

467

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

468

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

469

},

470

],

471

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

472

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

Bu Sun Kim

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

[diff] [blame]

473

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

Dmitry Frenkel

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

[diff] [blame]

474

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

Bu Sun Kim

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

[diff] [blame^]

475

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

476

},

477

],

478

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

479

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

480

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

481

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

482

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

Dmitry Frenkel

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

[diff] [blame]

483

},

484

],

485

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

486

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

Bu Sun Kim

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

[diff] [blame]

487

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

Bu Sun Kim

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

[diff] [blame^]

488

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

Bu Sun Kim

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

[diff] [blame]

489

},

490

],

491

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

492

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

493

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

494

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

495

},

496

],

Bu Sun Kim

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

[diff] [blame^]

497

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

498

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

499

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

500

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

501

},

Bu Sun Kim

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

[diff] [blame]

502

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

503

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

Bu Sun Kim

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

[diff] [blame]

504

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

505

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

Bu Sun Kim

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

[diff] [blame^]

506

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

507

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

Dmitry Frenkel

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

[diff] [blame]

},

],

},

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

Bu Sun Kim

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

[diff] [blame^]

512

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

513

"a_key": "A String",

514

},

515

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

516

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

517

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

518

"A String",

519

],

520

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

521

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

522

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

523

},

524

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

525

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

526

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

527

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

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

},

536

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

537

"a_key": "A String",

538

},

539

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

540

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

541

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

542

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

543

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

544

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

545

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

546

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

547

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

548

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

549

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

550

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

551

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

552

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

553

},

554

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

555

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

556

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

557

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

558

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

559

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

560

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

561

"A String",

562

],

563

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

564

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

565

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

566

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

567

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

568

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

569

},

570

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

571

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

572

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

573

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

574

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

575

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

576

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

577

},

578

],

579

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

580

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

581

},

582

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

583

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

584

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

585

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

586

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

587

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

588

},

589

],

590

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

591

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

592

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

593

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

594

"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

595

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

596

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

597

},

598

],

599

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

600

},

601

],

602

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

603

"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

604

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

605

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

606

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

607

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

608

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

609

"internalExperiments": { # Experimental settings.

610

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

611

},

612

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

613

"A String",

614

],

615

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

616

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

617

},

618

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

619

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

620

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

621

},

622

},

623

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

624

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

625

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

626

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

],

},

},

},

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

633

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

634

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

635

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

636

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

637

},

638

],

639

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

640

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

641

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

642

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

643

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

644

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

645

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

646

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

647

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

648

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

649

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

650

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

651

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

652

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

653

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

654

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

655

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

656

},

657

],

658

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

659

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

660

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

661

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

662

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

663

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

664

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

665

},

666

],

667

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

668

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

669

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

670

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

671

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

672

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

673

},

674

],

675

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

676

"A String",

677

],

678

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

679

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

680

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

681

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

682

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

},

],

},

],

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

688

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

689

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

690

"A String",

691

],

692

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

693

"A String",

694

],

695

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

696

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

697

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

698

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

699

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

700

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

701

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

702

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

703

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

704

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

705

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

706

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

707

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

708

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

709

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

710

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

711

},

712

],

713

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

714

},

715

],

716

"displayData": [ # Pipeline level display data.

717

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

718

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

719

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

720

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

721

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

722

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

723

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

724

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

725

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

726

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

727

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

728

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

729

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

},

],

},

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

734

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

735

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

736

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

Dmitry Frenkel

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

[diff] [blame]

}</pre>

</div>

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

742

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

743

744

Args:

745

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

746

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

747

jobId: string, The job ID. (required)

748

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

749

Allowed values

750

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.

751

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.

752

JOB_VIEW_ALL - Request all information available for this job.

753

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

754

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

761

762

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

Dmitry Frenkel

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

[diff] [blame]

763

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

764

"a_key": "A String",

765

},

766

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

767

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

768

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

769

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

770

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

771

},

772

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

773

},

774

],

Dmitry Frenkel

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

[diff] [blame]

775

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

Dmitry Frenkel

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

[diff] [blame]

776

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

Bu Sun Kim

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

[diff] [blame]

777

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

778

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

779

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

780

},

781

],

Dmitry Frenkel

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

[diff] [blame]

782

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

783

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

784

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

Dmitry Frenkel

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

[diff] [blame]

785

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

Bu Sun Kim

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

[diff] [blame^]

786

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

787

},

788

],

789

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

790

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

791

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

792

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

793

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

Dmitry Frenkel

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

[diff] [blame]

794

},

795

],

Bu Sun Kim

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

[diff] [blame]

796

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

797

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

Bu Sun Kim

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

[diff] [blame]

798

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

Bu Sun Kim

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

[diff] [blame^]

799

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

Bu Sun Kim

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

[diff] [blame]

800

},

801

],

Dmitry Frenkel

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

[diff] [blame]

802

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

803

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

804

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

805

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

806

},

807

],

Bu Sun Kim

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

[diff] [blame^]

808

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

809

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

810

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

811

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

812

},

Dmitry Frenkel

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

[diff] [blame]

813

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

814

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

Dmitry Frenkel

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

[diff] [blame]

815

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

816

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

Bu Sun Kim

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

[diff] [blame^]

817

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

818

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

Bu Sun Kim

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

[diff] [blame]

819

},

820

],

821

},

Dmitry Frenkel

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

[diff] [blame]

822

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

Bu Sun Kim

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

[diff] [blame^]

823

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

824

"a_key": "A String",

825

},

826

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

827

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

828

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

829

"A String",

830

],

831

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

832

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

833

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

834

},

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

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

845

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

846

},

847

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

848

"a_key": "A String",

849

},

850

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

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

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

860

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

861

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

862

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

863

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

864

},

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

"A String",

873

],

874

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

875

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

876

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

877

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

878

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

879

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

880

},

881

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

882

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

883

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

884

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

885

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

886

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

887

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

888

},

889

],

890

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

891

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

892

},

893

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

894

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

895

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

896

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

897

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

898

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

899

},

900

],

901

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

902

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

903

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

904

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

905

"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

906

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

907

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

908

},

909

],

910

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

911

},

912

],

913

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

914

"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

915

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

916

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

917

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

918

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

919

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

920

"internalExperiments": { # Experimental settings.

921

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

922

},

923

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

924

"A String",

925

],

926

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

927

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

928

},

929

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

930

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

931

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

932

},

933

},

934

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

935

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

936

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

937

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

],

},

},

},

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

944

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

945

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

946

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

947

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

948

},

949

],

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

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

959

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

960

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

961

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

962

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

963

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

964

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

965

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

966

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

967

},

968

],

969

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

970

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

971

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

972

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

973

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

974

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

975

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

976

},

977

],

978

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

979

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

980

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

981

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

982

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

983

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

984

},

985

],

986

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

987

"A String",

988

],

989

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

990

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

991

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

992

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

993

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

},

],

},

],

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

999

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

1000

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

1001

"A String",

1002

],

1003

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

1004

"A String",

1005

],

1006

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

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

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

1014

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

1015

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

1016

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

1017

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

1018

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

1019

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

1020

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

1021

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

1022

},

1023

],

1024

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

1025

},

1026

],

1027

"displayData": [ # Pipeline level display data.

1028

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

1029

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

1030

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

1031

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

1032

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

1033

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

1034

"durationValue": "A String", # Contains value if the data is of duration 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

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

1037

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

1038

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

1039

"strValue": "A String", # Contains value if the data is of string 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.

},

],

},

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

1045

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

1046

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

1047

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

Dmitry Frenkel

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

[diff] [blame]

1048

}</pre>

Bu Sun Kim

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

[diff] [blame]

</div>

Bu Sun Kim

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

[diff] [blame^]

1052

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

Dmitry Frenkel

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

[diff] [blame]

1053

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

Bu Sun Kim

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

[diff] [blame]

1054

Jon Wayne Parrott

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

[diff] [blame]

1055

Args:

1056

projectId: string, A project id. (required)

Dmitry Frenkel

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

[diff] [blame]

1057

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

1058

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

Dmitry Frenkel

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

[diff] [blame]

1059

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

Bu Sun Kim

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

[diff] [blame^]

1060

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

Jon Wayne Parrott

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

[diff] [blame]

1061

x__xgafv: string, V1 error format.

Sai Cheemalapati

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

[diff] [blame]

1062

Allowed values

1063

1 - v1 error format

1064

2 - v2 error format

Jon Wayne Parrott

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

[diff] [blame]

1065

1066

Returns:

1067

An object of the form:

1068

Dmitry Frenkel

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

[diff] [blame]

1069

{ # Information about the execution of a job.

Dmitry Frenkel

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

[diff] [blame]

1070

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

1071

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

Bu Sun Kim

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

[diff] [blame^]

1072

"endTime": "A String", # End time of this stage. If the work item is completed, this is the actual end time of the stage. Otherwise, it is the predicted end time.

Dmitry Frenkel

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

[diff] [blame]

1073

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

1074

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

1075

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

1076

{ # A point in the timeseries.

Dmitry Frenkel

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

[diff] [blame]

1077

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

Bu Sun Kim

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

[diff] [blame^]

1078

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

Dmitry Frenkel

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

[diff] [blame]

1079

},

1080

],

Bu Sun Kim

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

[diff] [blame]

1081

},

Bu Sun Kim

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

[diff] [blame^]

1082

"startTime": "A String", # Start time of this stage.

1083

"state": "A String", # State of this stage.

Dmitry Frenkel

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

[diff] [blame]

1084

"metrics": [ # Metrics for this stage.

1085

{ # Describes the state of a metric.

Bu Sun Kim

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

[diff] [blame^]

1086

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1087

"distribution": "", # A struct value describing properties of a distribution of numeric values.

Dmitry Frenkel

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

[diff] [blame]

1088

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

Bu Sun Kim

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

[diff] [blame^]

1089

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

1090

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

1091

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

1092

"scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

1093

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

1094

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

Dmitry Frenkel

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

[diff] [blame]

1095

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

1096

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

1097

"name": "A String", # Worker-defined metric name.

1098

"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'] = .

1099

"a_key": "A String",

1100

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1101

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1102

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1103

},

1104

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1105

"stageId": "A String", # ID of this stage

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1106

},

1107

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1108

"nextPageToken": "A String", # If present, this response does not contain all requested tasks. To obtain the next page of results, repeat the request with page_token set to this value.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1113

<code class="details" id="getExecutionDetails_next">getExecutionDetails_next(previous_request, previous_response)</code>

1114

<pre>Retrieves the next page of results.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1115

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1116

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1117

previous_request: The request for the previous page. (required)

1118

previous_response: The response from the request for the previous page. (required)

1119

1120

Returns:

1121

A request object that you can call 'execute()' on to request the next

1122

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="getMetrics">getMetrics(projectId, location, jobId, startTime=None, x__xgafv=None)</code>

1128

<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`.

1129

1130

Args:

1131

projectId: string, A project id. (required)

1132

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)

1133

jobId: string, The job to get metrics for. (required)

1134

startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1135

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1136

Allowed values

1137

1 - v1 error format

1138

2 - v2 error format

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1139

1140

Returns:

1141

An object of the form:

1142

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1143

{ # 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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1144

"metricTime": "A String", # Timestamp as of which metric values are current.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1145

"metrics": [ # All metrics for this job.

1146

{ # Describes the state of a metric.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1147

"internal": "", # Worker-computed aggregate value for internal use by the Dataflow service.

1148

"distribution": "", # A struct value describing properties of a distribution of numeric values.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1149

"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.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1150

"updateTime": "A String", # Timestamp associated with the metric value. Optional when workers are reporting work progress; it will be filled in responses from the metrics API.

1151

"gauge": "", # A struct value describing properties of a Gauge. Metrics of gauge type show the value of a metric across time, and is aggregated based on the newest value.

1152

"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.

1153

"scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean.

1154

"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.

1155

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1156

"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^]

1157

"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]

1158

"name": "A String", # Worker-defined metric name.

1159

"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]

1160

"a_key": "A String",

1161

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1162

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1163

"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.

Bu Sun Kim

4ed7d3f

2020-05-27 12:20:54 -0700

[diff] [blame]

1164

},

1165

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1170

<code class="details" id="list">list(projectId, location, pageToken=None, view=None, filter=None, pageSize=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1171

<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`.

1172

1173

Args:

1174

projectId: string, The project which owns the jobs. (required)

1175

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1176

pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list.

1177

view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.

1178

Allowed values

1179

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.

1180

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.

1181

JOB_VIEW_ALL - Request all information available for this job.

1182

JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment.

1183

filter: string, The kind of filter to use.

1184

Allowed values

1185

UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`.

1186

ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp.

1187

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.

1188

ACTIVE - Filters the jobs that are running ordered on the creation timestamp.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1189

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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1190

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1197

1198

{ # 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^]

1199

"nextPageToken": "A String", # Set if there may be more results than fit in this response.

1200

"failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1201

{ # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data.

1202

"name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond.

1203

},

1204

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1205

"jobs": [ # A subset of the requested job information.

1206

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1207

"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.

1208

"a_key": "A String",

1209

},

1210

"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.

1211

{ # 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.

1212

"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.

1213

"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.

1214

"a_key": "", # Properties of the object.

1215

},

1216

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1217

},

1218

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1219

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1220

"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.

1221

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1222

{ # Metadata for a File connector used by the job.

1223

"filePattern": "A String", # File Pattern used to access files by the connector.

1224

},

1225

],

1226

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1227

{ # Metadata for a Spanner connector used by the job.

1228

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1229

"databaseId": "A String", # DatabaseId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1230

"projectId": "A String", # ProjectId accessed in the connection.

1231

},

1232

],

1233

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1234

{ # Metadata for a BigTable connector used by the job.

1235

"projectId": "A String", # ProjectId accessed in the connection.

1236

"instanceId": "A String", # InstanceId accessed in the connection.

1237

"tableId": "A String", # TableId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1238

},

1239

],

1240

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1241

{ # Metadata for a Datastore connector used by the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1242

"projectId": "A String", # ProjectId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1243

"namespace": "A String", # Namespace used in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1244

},

1245

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1246

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1247

{ # Metadata for a PubSub connector used by the job.

1248

"subscription": "A String", # Subscription used in the connection.

1249

"topic": "A String", # Topic accessed in the connection.

1250

},

1251

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1252

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1253

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1254

"version": "A String", # The version of the SDK used to run the job.

1255

"sdkSupportStatus": "A String", # The support status for this SDK version.

1256

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1257

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1258

{ # Metadata for a BigQuery connector used by the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1259

"query": "A String", # Query used to access data in the connection.

1260

"table": "A String", # Table accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1261

"dataset": "A String", # Dataset accessed in the connection.

1262

"projectId": "A String", # Project accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1267

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1268

"a_key": "A String",

1269

},

1270

"type": "A String", # The type of Cloud Dataflow job.

1271

"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.

1272

"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}

1273

"A String",

1274

],

1275

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1276

"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.

1277

"a_key": "", # Properties of the object.

1278

},

1279

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1280

{ # 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.

1281

"diskSourceImage": "A String", # Fully qualified source image for disks.

1282

"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.

1283

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1284

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1285

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1286

"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).

1287

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1288

"algorithm": "A String", # The algorithm to use for autoscaling.

1289

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1290

},

1291

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1292

"a_key": "A String",

1293

},

1294

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1295

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1296

"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}

1297

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1298

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1299

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1300

"logDir": "A String", # The directory on the VM to store logs.

1301

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1302

"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}

1303

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1304

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1305

"workerId": "A String", # The ID of the worker running this pipeline.

1306

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1307

"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/"

1308

},

1309

"vmId": "A String", # The ID string of the VM.

1310

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1311

"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/"

1312

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1313

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1314

"harnessCommand": "A String", # The command to launch the worker harness.

1315

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1316

"A String",

1317

],

1318

"languageHint": "A String", # The suggested backend language.

1319

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1320

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1321

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1322

"workflowFileName": "A String", # The file to store the workflow in.

1323

"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}

1324

},

1325

"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.

1326

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1327

"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.

1328

"packages": [ # Packages to be installed on workers.

1329

{ # 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.

1330

"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/

1331

"name": "A String", # The name of the package.

1332

},

1333

],

1334

"poolArgs": { # Extra arguments for this worker pool.

1335

"a_key": "", # Properties of the object. Contains field @type with type URL.

1336

},

1337

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1338

"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.

1339

"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.

1340

{ # Defines a SDK harness container for executing Dataflow pipelines.

1341

"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.

1342

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1343

},

1344

],

1345

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1346

"ipConfiguration": "A String", # Configuration for VM IPs.

1347

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1348

{ # Describes the data disk used by a workflow job.

1349

"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

1350

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1351

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1352

},

1353

],

1354

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1355

},

1356

],

1357

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1358

"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

1359

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1360

"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".

1361

"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.

1362

"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}

1363

"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.

1364

"internalExperiments": { # Experimental settings.

1365

"a_key": "", # Properties of the object. Contains field @type with type URL.

1366

},

1367

"experiments": [ # The list of experiments to enable.

1368

"A String",

1369

],

1370

"userAgent": { # A description of the process that generated the request.

1371

"a_key": "", # Properties of the object.

1372

},

1373

"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}

1374

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1375

"a_key": "", # Properties of the object.

1376

},

1377

},

1378

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1379

"stages": { # A mapping from each stage to the information about that stage.

1380

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1381

"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",

],

},

},

},

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1388

{ # A message describing the state of a particular execution stage.

1389

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1390

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1391

"executionStageName": "A String", # The name of the execution stage.

1392

},

1393

],

1394

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1395

"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.

1396

"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.

1397

"currentStateTime": "A String", # The timestamp associated with the current state.

1398

"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.

1399

"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.

1400

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1401

"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.

1402

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1403

{ # 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.

1404

"name": "A String", # Dataflow service generated name for this stage.

1405

"id": "A String", # Dataflow service generated id for this stage.

1406

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1407

{ # Description of an interstitial value between transforms in an execution stage.

1408

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1409

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1410

"name": "A String", # Dataflow service generated name for this source.

1411

},

1412

],

1413

"kind": "A String", # Type of tranform this stage is executing.

1414

"inputSource": [ # Input sources for this stage.

1415

{ # Description of an input or output of an execution stage.

1416

"sizeBytes": "A String", # Size of the source, if measurable.

1417

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1418

"name": "A String", # Dataflow service generated name for this source.

1419

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1420

},

1421

],

1422

"outputSource": [ # Output sources for this stage.

1423

{ # Description of an input or output of an execution stage.

1424

"sizeBytes": "A String", # Size of the source, if measurable.

1425

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1426

"name": "A String", # Dataflow service generated name for this source.

1427

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1428

},

1429

],

1430

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

1431

"A String",

1432

],

1433

"componentTransform": [ # Transforms that comprise this execution stage.

1434

{ # Description of a transform executed as part of an execution stage.

1435

"name": "A String", # Dataflow service generated name for this source.

1436

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1437

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

},

],

},

],

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1443

{ # Description of the type, names/ids, and input/outputs for a transform.

1444

"inputCollectionName": [ # User names for all collection inputs to this transform.

1445

"A String",

1446

],

1447

"outputCollectionName": [ # User names for all collection outputs to this transform.

1448

"A String",

1449

],

1450

"name": "A String", # User provided name for this transform instance.

1451

"id": "A String", # SDK generated id of this transform instance.

1452

"displayData": [ # Transform-specific display data.

1453

{ # Data provided with a pipeline or transform to provide descriptive info.

1454

"boolValue": True or False, # Contains value if the data is of a boolean type.

1455

"url": "A String", # An optional full URL.

1456

"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.

1457

"floatValue": 3.14, # Contains value if the data is of float type.

1458

"int64Value": "A String", # Contains value if the data is of int64 type.

1459

"durationValue": "A String", # Contains value if the data is of duration type.

1460

"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.

1461

"label": "A String", # An optional label to display in a dax UI for the element.

1462

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1463

"javaClassValue": "A String", # Contains value if the data is of java class type.

1464

"strValue": "A String", # Contains value if the data is of string type.

1465

"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.

1466

},

1467

],

1468

"kind": "A String", # Type of transform.

1469

},

1470

],

1471

"displayData": [ # Pipeline level display data.

1472

{ # Data provided with a pipeline or transform to provide descriptive info.

1473

"boolValue": True or False, # Contains value if the data is of a boolean type.

1474

"url": "A String", # An optional full URL.

1475

"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.

1476

"floatValue": 3.14, # Contains value if the data is of float type.

1477

"int64Value": "A String", # Contains value if the data is of int64 type.

1478

"durationValue": "A String", # Contains value if the data is of duration type.

1479

"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.

1480

"label": "A String", # An optional label to display in a dax UI for the element.

1481

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1482

"javaClassValue": "A String", # Contains value if the data is of java class type.

1483

"strValue": "A String", # Contains value if the data is of string type.

1484

"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.

},

],

},

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1489

"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.

1490

"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])?`

1491

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1492

},

1493

],

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1499

<pre>Retrieves the next page of results.

1500

1501

Args:

1502

previous_request: The request for the previous page. (required)

1503

previous_response: The response from the request for the previous page. (required)

1504

1505

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1506

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1507

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]

1512

<code class="details" id="snapshot">snapshot(projectId, location, jobId, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1513

<pre>Snapshot the state of a streaming job.

1514

1515

Args:

1516

projectId: string, The project which owns the job to be snapshotted. (required)

1517

location: string, The location that contains this job. (required)

1518

jobId: string, The job to be snapshotted. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1519

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1520

The object takes the form of:

1521

1522

{ # Request to create a snapshot of a job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1523

"ttl": "A String", # TTL for the snapshot.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1524

"snapshotSources": True or False, # If true, perform snapshots for sources which support this.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1525

"location": "A String", # The location that contains this job.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1526

"description": "A String", # User specified description of the snapshot. Maybe empty.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1527

}

1528

1529

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1536

1537

{ # Represents a snapshot of a job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1538

"pubsubMetadata": [ # PubSub snapshot metadata.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1539

{ # Represents a Pubsub snapshot.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1540

"topicName": "A String", # The name of the Pubsub topic.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1541

"expireTime": "A String", # The expire time of the Pubsub snapshot.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1542

"snapshotName": "A String", # The name of the Pubsub snapshot.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1543

},

1544

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1545

"creationTime": "A String", # The time this snapshot was created.

1546

"projectId": "A String", # The project this snapshot belongs to.

1547

"description": "A String", # User specified description of the snapshot. Maybe empty.

1548

"sourceJobId": "A String", # The job this snapshot was created from.

1549

"ttl": "A String", # The time after which this snapshot will be automatically deleted.

1550

"id": "A String", # The unique ID of this snapshot.

1551

"diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY state.

1552

"state": "A String", # State of the snapshot.

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]

1557

<code class="details" id="update">update(projectId, location, jobId, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1558

<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]

1559

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1560

Args:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1561

projectId: string, The ID of the Cloud Platform project that the job belongs to. (required)

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1562

location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. (required)

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1563

jobId: string, The job ID. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1564

body: object, The request body.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1565

The object takes the form of:

1566

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1567

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1568

"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.

1569

"a_key": "A String",

1570

},

1571

"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.

1572

{ # 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.

1573

"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.

1574

"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.

1575

"a_key": "", # Properties of the object.

1576

},

1577

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1578

},

1579

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1580

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1581

"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.

1582

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1583

{ # Metadata for a File connector used by the job.

1584

"filePattern": "A String", # File Pattern used to access files by the connector.

1585

},

1586

],

1587

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1588

{ # Metadata for a Spanner connector used by the job.

1589

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1590

"databaseId": "A String", # DatabaseId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1591

"projectId": "A String", # ProjectId accessed in the connection.

1592

},

1593

],

1594

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1595

{ # Metadata for a BigTable connector used by the job.

1596

"projectId": "A String", # ProjectId accessed in the connection.

1597

"instanceId": "A String", # InstanceId accessed in the connection.

1598

"tableId": "A String", # TableId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1599

},

1600

],

1601

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1602

{ # Metadata for a Datastore connector used by the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1603

"projectId": "A String", # ProjectId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1604

"namespace": "A String", # Namespace used in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1605

},

1606

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1607

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1608

{ # Metadata for a PubSub connector used by the job.

1609

"subscription": "A String", # Subscription used in the connection.

1610

"topic": "A String", # Topic accessed in the connection.

1611

},

1612

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1613

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1614

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1615

"version": "A String", # The version of the SDK used to run the job.

1616

"sdkSupportStatus": "A String", # The support status for this SDK version.

1617

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1618

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1619

{ # Metadata for a BigQuery connector used by the job.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1620

"query": "A String", # Query used to access data in the connection.

1621

"table": "A String", # Table accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1622

"dataset": "A String", # Dataset accessed in the connection.

1623

"projectId": "A String", # Project accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

},

],

},

"stepsLocation": "A String", # The GCS location where the steps are stored.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1628

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1629

"a_key": "A String",

1630

},

1631

"type": "A String", # The type of Cloud Dataflow job.

1632

"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.

1633

"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}

1634

"A String",

1635

],

1636

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1637

"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.

1638

"a_key": "", # Properties of the object.

1639

},

1640

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1641

{ # 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.

1642

"diskSourceImage": "A String", # Fully qualified source image for disks.

1643

"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.

1644

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1645

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1646

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1647

"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).

1648

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1649

"algorithm": "A String", # The algorithm to use for autoscaling.

1650

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1651

},

1652

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1653

"a_key": "A String",

1654

},

1655

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1656

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1657

"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}

1658

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1659

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1660

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1661

"logDir": "A String", # The directory on the VM to store logs.

1662

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1663

"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}

1664

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1665

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1666

"workerId": "A String", # The ID of the worker running this pipeline.

1667

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1668

"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/"

1669

},

1670

"vmId": "A String", # The ID string of the VM.

1671

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1672

"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/"

1673

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1674

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1675

"harnessCommand": "A String", # The command to launch the worker harness.

1676

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1677

"A String",

1678

],

1679

"languageHint": "A String", # The suggested backend language.

1680

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1681

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1682

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1683

"workflowFileName": "A String", # The file to store the workflow in.

1684

"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}

1685

},

1686

"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.

1687

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1688

"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.

1689

"packages": [ # Packages to be installed on workers.

1690

{ # 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.

1691

"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/

1692

"name": "A String", # The name of the package.

1693

},

1694

],

1695

"poolArgs": { # Extra arguments for this worker pool.

1696

"a_key": "", # Properties of the object. Contains field @type with type URL.

1697

},

1698

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1699

"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.

1700

"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.

1701

{ # Defines a SDK harness container for executing Dataflow pipelines.

1702

"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.

1703

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

1704

},

1705

],

1706

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

1707

"ipConfiguration": "A String", # Configuration for VM IPs.

1708

"dataDisks": [ # Data disks that are used by a VM in this workflow.

1709

{ # Describes the data disk used by a workflow job.

1710

"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

1711

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1712

"mountPoint": "A String", # Directory in a VM where disk is mounted.

1713

},

1714

],

1715

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

1716

},

1717

],

1718

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

1719

"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

1720

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

1721

"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".

1722

"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.

1723

"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}

1724

"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.

1725

"internalExperiments": { # Experimental settings.

1726

"a_key": "", # Properties of the object. Contains field @type with type URL.

1727

},

1728

"experiments": [ # The list of experiments to enable.

1729

"A String",

1730

],

1731

"userAgent": { # A description of the process that generated the request.

1732

"a_key": "", # Properties of the object.

1733

},

1734

"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}

1735

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

1736

"a_key": "", # Properties of the object.

1737

},

1738

},

1739

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

1740

"stages": { # A mapping from each stage to the information about that stage.

1741

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

1742

"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",

],

},

},

},

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

1749

{ # A message describing the state of a particular execution stage.

1750

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

1751

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

1752

"executionStageName": "A String", # The name of the execution stage.

1753

},

1754

],

1755

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

1756

"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.

1757

"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.

1758

"currentStateTime": "A String", # The timestamp associated with the current state.

1759

"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.

1760

"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.

1761

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

1762

"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.

1763

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

1764

{ # 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.

1765

"name": "A String", # Dataflow service generated name for this stage.

1766

"id": "A String", # Dataflow service generated id for this stage.

1767

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

1768

{ # Description of an interstitial value between transforms in an execution stage.

1769

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

1770

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1771

"name": "A String", # Dataflow service generated name for this source.

1772

},

1773

],

1774

"kind": "A String", # Type of tranform this stage is executing.

1775

"inputSource": [ # Input sources for this stage.

1776

{ # Description of an input or output of an execution stage.

1777

"sizeBytes": "A String", # Size of the source, if measurable.

1778

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1779

"name": "A String", # Dataflow service generated name for this source.

1780

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1781

},

1782

],

1783

"outputSource": [ # Output sources for this stage.

1784

{ # Description of an input or output of an execution stage.

1785

"sizeBytes": "A String", # Size of the source, if measurable.

1786

"userName": "A String", # Human-readable name for this source; may be user or system generated.

1787

"name": "A String", # Dataflow service generated name for this source.

1788

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

1789

},

1790

],

1791

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

1792

"A String",

1793

],

1794

"componentTransform": [ # Transforms that comprise this execution stage.

1795

{ # Description of a transform executed as part of an execution stage.

1796

"name": "A String", # Dataflow service generated name for this source.

1797

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

1798

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

},

],

},

],

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

1804

{ # Description of the type, names/ids, and input/outputs for a transform.

1805

"inputCollectionName": [ # User names for all collection inputs to this transform.

1806

"A String",

1807

],

1808

"outputCollectionName": [ # User names for all collection outputs to this transform.

1809

"A String",

1810

],

1811

"name": "A String", # User provided name for this transform instance.

1812

"id": "A String", # SDK generated id of this transform instance.

1813

"displayData": [ # Transform-specific display data.

1814

{ # Data provided with a pipeline or transform to provide descriptive info.

1815

"boolValue": True or False, # Contains value if the data is of a boolean type.

1816

"url": "A String", # An optional full URL.

1817

"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.

1818

"floatValue": 3.14, # Contains value if the data is of float type.

1819

"int64Value": "A String", # Contains value if the data is of int64 type.

1820

"durationValue": "A String", # Contains value if the data is of duration type.

1821

"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.

1822

"label": "A String", # An optional label to display in a dax UI for the element.

1823

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1824

"javaClassValue": "A String", # Contains value if the data is of java class type.

1825

"strValue": "A String", # Contains value if the data is of string type.

1826

"shortStrValue": "A String", # A possible additional shorter value to display. For example a java_class_name_value of com.mypackage.MyDoFn will be stored with MyDoFn as the short_str_value and com.mypackage.MyDoFn as the java_class_name value. short_str_value can be displayed and java_class_name_value will be displayed as a tooltip.

1827

},

1828

],

1829

"kind": "A String", # Type of transform.

1830

},

1831

],

1832

"displayData": [ # Pipeline level display data.

1833

{ # Data provided with a pipeline or transform to provide descriptive info.

1834

"boolValue": True or False, # Contains value if the data is of a boolean type.

1835

"url": "A String", # An optional full URL.

1836

"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.

1837

"floatValue": 3.14, # Contains value if the data is of float type.

1838

"int64Value": "A String", # Contains value if the data is of int64 type.

1839

"durationValue": "A String", # Contains value if the data is of duration type.

1840

"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.

1841

"label": "A String", # An optional label to display in a dax UI for the element.

1842

"timestampValue": "A String", # Contains value if the data is of timestamp type.

1843

"javaClassValue": "A String", # Contains value if the data is of java class type.

1844

"strValue": "A String", # Contains value if the data is of string type.

1845

"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.

},

],

},

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

1850

"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.

1851

"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])?`

1852

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1853

}

1854

1855

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1862

1863

{ # Defines a job to be run by the Cloud Dataflow service.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1864

"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]

1865

"a_key": "A String",

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1866

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1867

"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.

1868

{ # 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.

1869

"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.

1870

"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.

1871

"a_key": "", # Properties of the object.

1872

},

1873

"kind": "A String", # The kind of step in the Cloud Dataflow job.

1874

},

1875

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1876

"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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1877

"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.

1878

"fileDetails": [ # Identification of a File source used in the Dataflow job.

1879

{ # Metadata for a File connector used by the job.

1880

"filePattern": "A String", # File Pattern used to access files by the connector.

1881

},

1882

],

1883

"spannerDetails": [ # Identification of a Spanner source used in the Dataflow job.

1884

{ # Metadata for a Spanner connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1885

"instanceId": "A String", # InstanceId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1886

"databaseId": "A String", # DatabaseId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1887

"projectId": "A String", # ProjectId accessed in the connection.

1888

},

1889

],

1890

"bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job.

1891

{ # Metadata for a BigTable connector used by the job.

1892

"projectId": "A String", # ProjectId accessed in the connection.

1893

"instanceId": "A String", # InstanceId accessed in the connection.

1894

"tableId": "A String", # TableId accessed in the connection.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1895

},

1896

],

1897

"datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job.

1898

{ # Metadata for a Datastore connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1899

"projectId": "A String", # ProjectId accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1900

"namespace": "A String", # Namespace used in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1901

},

1902

],

1903

"pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job.

1904

{ # Metadata for a PubSub connector used by the job.

1905

"subscription": "A String", # Subscription used in the connection.

1906

"topic": "A String", # Topic accessed in the connection.

1907

},

1908

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1909

"sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job.

1910

"versionDisplayName": "A String", # A readable string describing the version of the SDK.

1911

"version": "A String", # The version of the SDK used to run the job.

1912

"sdkSupportStatus": "A String", # The support status for this SDK version.

1913

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1914

"bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job.

1915

{ # Metadata for a BigQuery connector used by the job.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1916

"query": "A String", # Query used to access data in the connection.

1917

"table": "A String", # Table accessed in the connection.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1918

"dataset": "A String", # Dataset accessed in the connection.

1919

"projectId": "A String", # Project accessed in the connection.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

1920

},

1921

],

1922

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

1923

"stepsLocation": "A String", # The GCS location where the steps are stored.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

1924

"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.

1925

"a_key": "A String",

1926

},

1927

"type": "A String", # The type of Cloud Dataflow job.

1928

"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.

1929

"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}

1930

"A String",

1931

],

1932

"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.

1933

"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.

1934

"a_key": "", # Properties of the object.

1935

},

1936

"workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers.

1937

{ # 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.

1938

"diskSourceImage": "A String", # Fully qualified source image for disks.

1939

"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.

1940

"machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default.

1941

"diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

1942

"diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default.

1943

"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).

1944

"autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool.

1945

"algorithm": "A String", # The algorithm to use for autoscaling.

1946

"maxNumWorkers": 42, # The maximum number of workers to cap scaling at.

1947

},

1948

"metadata": { # Metadata to set on the Google Compute Engine VMs.

1949

"a_key": "A String",

1950

},

1951

"kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported.

1952

"taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field.

1953

"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}

1954

"commandlinesFileName": "A String", # The file to store preprocessing commands in.

1955

"dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3"

1956

"taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root".

1957

"logDir": "A String", # The directory on the VM to store logs.

1958

"parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness.

1959

"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}

1960

"reportingEnabled": True or False, # Whether to send work progress updates to the service.

1961

"shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1".

1962

"workerId": "A String", # The ID of the worker running this pipeline.

1963

"servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects".

1964

"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/"

1965

},

1966

"vmId": "A String", # The ID string of the VM.

1967

"continueOnException": True or False, # Whether to continue taskrunner if an exception is hit.

1968

"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/"

1969

"streamingWorkerMainClass": "A String", # The streaming worker main class name.

1970

"taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel".

1971

"harnessCommand": "A String", # The command to launch the worker harness.

1972

"oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API.

1973

"A String",

1974

],

1975

"languageHint": "A String", # The suggested backend language.

1976

"baseTaskDir": "A String", # The location on the worker for task-specific subdirectories.

1977

"alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr.

1978

"logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console.

1979

"workflowFileName": "A String", # The file to store the workflow in.

1980

"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}

1981

},

1982

"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.

1983

"network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default".

1984

"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.

1985

"packages": [ # Packages to be installed on workers.

1986

{ # 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.

1987

"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/

1988

"name": "A String", # The name of the package.

1989

},

1990

],

1991

"poolArgs": { # Extra arguments for this worker pool.

1992

"a_key": "", # Properties of the object. Contains field @type with type URL.

1993

},

1994

"onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API.

1995

"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.

1996

"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.

1997

{ # Defines a SDK harness container for executing Dataflow pipelines.

1998

"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.

1999

"containerImage": "A String", # A docker container image that resides in Google Container Registry.

2000

},

2001

],

2002

"subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK".

2003

"ipConfiguration": "A String", # Configuration for VM IPs.

2004

"dataDisks": [ # Data disks that are used by a VM in this workflow.

2005

{ # Describes the data disk used by a workflow job.

2006

"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

2007

"sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default.

2008

"mountPoint": "A String", # Directory in a VM where disk is mounted.

2009

},

2010

],

2011

"zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default.

2012

},

2013

],

2014

"serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account.

2015

"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

2016

"flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in.

2017

"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".

2018

"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.

2019

"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}

2020

"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.

2021

"internalExperiments": { # Experimental settings.

2022

"a_key": "", # Properties of the object. Contains field @type with type URL.

2023

},

2024

"experiments": [ # The list of experiments to enable.

2025

"A String",

2026

],

2027

"userAgent": { # A description of the process that generated the request.

2028

"a_key": "", # Properties of the object.

2029

},

2030

"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}

2031

"version": { # A structure describing which components and their versions of the service are required in order to run the job.

2032

"a_key": "", # Properties of the object.

2033

},

2034

},

2035

"executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated.

2036

"stages": { # A mapping from each stage to the information about that stage.

2037

"a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed.

2038

"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",

],

},

},

},

"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.

2045

{ # A message describing the state of a particular execution stage.

2046

"currentStateTime": "A String", # The time at which the stage transitioned to this state.

2047

"executionStageState": "A String", # Executions stage states allow the same set of values as JobState.

2048

"executionStageName": "A String", # The name of the execution stage.

2049

},

2050

],

2051

"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.

2052

"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.

2053

"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.

2054

"currentStateTime": "A String", # The timestamp associated with the current state.

2055

"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.

2056

"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.

2057

"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.

2058

"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.

2059

"executionPipelineStage": [ # Description of each stage of execution of the pipeline.

2060

{ # 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.

2061

"name": "A String", # Dataflow service generated name for this stage.

2062

"id": "A String", # Dataflow service generated id for this stage.

2063

"componentSource": [ # Collections produced and consumed by component transforms of this stage.

2064

{ # Description of an interstitial value between transforms in an execution stage.

2065

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

2066

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2067

"name": "A String", # Dataflow service generated name for this source.

2068

},

2069

],

2070

"kind": "A String", # Type of tranform this stage is executing.

2071

"inputSource": [ # Input sources for this stage.

2072

{ # Description of an input or output of an execution stage.

2073

"sizeBytes": "A String", # Size of the source, if measurable.

2074

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2075

"name": "A String", # Dataflow service generated name for this source.

2076

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2077

},

2078

],

2079

"outputSource": [ # Output sources for this stage.

2080

{ # Description of an input or output of an execution stage.

2081

"sizeBytes": "A String", # Size of the source, if measurable.

2082

"userName": "A String", # Human-readable name for this source; may be user or system generated.

2083

"name": "A String", # Dataflow service generated name for this source.

2084

"originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated.

2085

},

2086

],

2087

"prerequisiteStage": [ # Other stages that must complete before this stage can run.

2088

"A String",

2089

],

2090

"componentTransform": [ # Transforms that comprise this execution stage.

2091

{ # Description of a transform executed as part of an execution stage.

2092

"name": "A String", # Dataflow service generated name for this source.

2093

"originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated.

2094

"userName": "A String", # Human-readable name for this transform; may be user or system generated.

},

],

},

],

"originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them.

2100

{ # Description of the type, names/ids, and input/outputs for a transform.

2101

"inputCollectionName": [ # User names for all collection inputs to this transform.

2102

"A String",

2103

],

2104

"outputCollectionName": [ # User names for all collection outputs to this transform.

2105

"A String",

2106

],

2107

"name": "A String", # User provided name for this transform instance.

2108

"id": "A String", # SDK generated id of this transform instance.

2109

"displayData": [ # Transform-specific display data.

2110

{ # Data provided with a pipeline or transform to provide descriptive info.

2111

"boolValue": True or False, # Contains value if the data is of a boolean type.

2112

"url": "A String", # An optional full URL.

2113

"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.

2114

"floatValue": 3.14, # Contains value if the data is of float type.

2115

"int64Value": "A String", # Contains value if the data is of int64 type.

2116

"durationValue": "A String", # Contains value if the data is of duration type.

2117

"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.

2118

"label": "A String", # An optional label to display in a dax UI for the element.

2119

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2120

"javaClassValue": "A String", # Contains value if the data is of java class type.

2121

"strValue": "A String", # Contains value if the data is of string type.

2122

"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.

2123

},

2124

],

2125

"kind": "A String", # Type of transform.

2126

},

2127

],

2128

"displayData": [ # Pipeline level display data.

2129

{ # Data provided with a pipeline or transform to provide descriptive info.

2130

"boolValue": True or False, # Contains value if the data is of a boolean type.

2131

"url": "A String", # An optional full URL.

2132

"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.

2133

"floatValue": 3.14, # Contains value if the data is of float type.

2134

"int64Value": "A String", # Contains value if the data is of int64 type.

2135

"durationValue": "A String", # Contains value if the data is of duration type.

2136

"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.

2137

"label": "A String", # An optional label to display in a dax UI for the element.

2138

"timestampValue": "A String", # Contains value if the data is of timestamp type.

2139

"javaClassValue": "A String", # Contains value if the data is of java class type.

2140

"strValue": "A String", # Contains value if the data is of string type.

2141

"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.

},

],

},

"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

2146

"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.

2147

"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])?`

2148

"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

2149

}</pre>

Jon Wayne Parrott