| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 75 | <h1><a href="dataflow_v1b3.html">Dataflow API</a> . <a href="dataflow_v1b3.projects.html">projects</a> . <a href="dataflow_v1b3.projects.jobs.html">jobs</a></h1> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 78 | <code><a href="dataflow_v1b3.projects.jobs.debug.html">debug()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the debug Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 83 | <code><a href="dataflow_v1b3.projects.jobs.messages.html">messages()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the messages Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| 88 | <code><a href="dataflow_v1b3.projects.jobs.workItems.html">workItems()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the workItems Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 93 | <code><a href="#aggregated">aggregated(projectId, filter=None, pageToken=None, location=None, view=None, pageSize=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 94 | <p class="firstline">List the jobs of a project across all regions.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#aggregated_next">aggregated_next(previous_request, previous_response)</a></code></p> |
| 97 | <p class="firstline">Retrieves the next page of results.</p> |
| 98 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 99 | <code><a href="#close">close()</a></code></p> |
| 100 | <p class="firstline">Close httplib2 connections.</p> |
| 101 | <p class="toc_element"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 102 | <code><a href="#create">create(projectId, body=None, location=None, view=None, replaceJobId=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 103 | <p class="firstline">Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 104 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 105 | <code><a href="#get">get(projectId, jobId, location=None, view=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 106 | <p class="firstline">Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 107 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 108 | <code><a href="#getMetrics">getMetrics(projectId, jobId, startTime=None, location=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 109 | <p class="firstline">Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 110 | <p class="toc_element"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 111 | <code><a href="#list">list(projectId, view=None, pageSize=None, location=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 112 | <p class="firstline">List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 113 | <p class="toc_element"> |
| 114 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 115 | <p class="firstline">Retrieves the next page of results.</p> |
| 116 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 117 | <code><a href="#snapshot">snapshot(projectId, jobId, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 118 | <p class="firstline">Snapshot the state of a streaming job.</p> |
| 119 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 120 | <code><a href="#update">update(projectId, jobId, body=None, location=None, x__xgafv=None)</a></code></p> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 121 | <p class="firstline">Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`.</p> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 122 | <h3>Method Details</h3> |
| 123 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 124 | <code class="details" id="aggregated">aggregated(projectId, filter=None, pageToken=None, location=None, view=None, pageSize=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 125 | <pre>List the jobs of a project across all regions. |
| 126 | |
| 127 | Args: |
| 128 | projectId: string, The project which owns the jobs. (required) |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 129 | filter: string, The kind of filter to use. |
| 130 | Allowed values |
| 131 | UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`. |
| 132 | ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp. |
| 133 | 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. |
| 134 | ACTIVE - Filters the jobs that are running ordered on the creation timestamp. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 135 | pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 136 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 137 | view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. |
| 138 | Allowed values |
| 139 | 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. |
| 140 | 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. |
| 141 | JOB_VIEW_ALL - Request all information available for this job. |
| 142 | JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment. |
| 143 | pageSize: integer, If there are many jobs, limit response to at most this many. The actual number of jobs returned will be the lesser of max_responses and an unspecified server-defined limit. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 152 | { # Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 153 | "jobs": [ # A subset of the requested job information. |
| 154 | { # Defines a job to be run by the Cloud Dataflow service. |
| 155 | "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. |
| 156 | "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. |
| 157 | { # 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. |
| 158 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 159 | "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. |
| 160 | "a_key": "", # Properties of the object. |
| 161 | }, |
| 162 | "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. |
| 163 | }, |
| 164 | ], |
| 165 | "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. |
| 166 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 167 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 168 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 169 | "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} |
| 170 | "userAgent": { # A description of the process that generated the request. |
| 171 | "a_key": "", # Properties of the object. |
| 172 | }, |
| 173 | "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 |
| 174 | "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. |
| 175 | "experiments": [ # The list of experiments to enable. |
| 176 | "A String", |
| 177 | ], |
| 178 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 179 | { # 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. |
| 180 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 181 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 182 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 183 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 184 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 185 | "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/" |
| 186 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 187 | "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} |
| 188 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| 189 | }, |
| 190 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 191 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 192 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 193 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 194 | "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} |
| 195 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| 196 | "A String", |
| 197 | ], |
| 198 | "vmId": "A String", # The ID string of the VM. |
| 199 | "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/" |
| 200 | "workflowFileName": "A String", # The file to store the workflow in. |
| 201 | "languageHint": "A String", # The suggested backend language. |
| 202 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 203 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 204 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 205 | "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} |
| 206 | "logDir": "A String", # The directory on the VM to store logs. |
| 207 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 208 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 209 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| 210 | }, |
| 211 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 212 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 213 | "a_key": "A String", |
| 214 | }, |
| 215 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 216 | { # Describes the data disk used by a workflow job. |
| 217 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 218 | "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 |
| 219 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 220 | }, |
| 221 | ], |
| 222 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 223 | "packages": [ # Packages to be installed on workers. |
| 224 | { # 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. |
| 225 | "name": "A String", # The name of the package. |
| 226 | "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/ |
| 227 | }, |
| 228 | ], |
| 229 | "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. |
| 230 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 231 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 232 | "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. |
| 233 | }, |
| 234 | ], |
| 235 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 236 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 237 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 238 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 239 | }, |
| 240 | "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. |
| 241 | "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. |
| 242 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 243 | "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. |
| 244 | "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. |
| 245 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 246 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 247 | "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). |
| 248 | "poolArgs": { # Extra arguments for this worker pool. |
| 249 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 250 | }, |
| 251 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 252 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 253 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 254 | }, |
| 255 | ], |
| 256 | "internalExperiments": { # Experimental settings. |
| 257 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 258 | }, |
| 259 | "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. |
| 260 | "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". |
| 261 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 262 | "a_key": "", # Properties of the object. |
| 263 | }, |
| 264 | "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. |
| 265 | "a_key": "", # Properties of the object. |
| 266 | }, |
| 267 | "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} |
| 268 | }, |
| 269 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 270 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 271 | "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} |
| 272 | "A String", |
| 273 | ], |
| 274 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 275 | "stages": { # A mapping from each stage to the information about that stage. |
| 276 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 277 | "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. |
| 278 | "A String", |
| 279 | ], |
| 280 | }, |
| 281 | }, |
| 282 | }, |
| 283 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 284 | "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. |
| 285 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 286 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 287 | "version": "A String", # The version of the SDK used to run the job. |
| 288 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 289 | }, |
| 290 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 291 | { # Metadata for a BigQuery connector used by the job. |
| 292 | "query": "A String", # Query used to access data in the connection. |
| 293 | "projectId": "A String", # Project accessed in the connection. |
| 294 | "table": "A String", # Table accessed in the connection. |
| 295 | "dataset": "A String", # Dataset accessed in the connection. |
| 296 | }, |
| 297 | ], |
| 298 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 299 | { # Metadata for a Datastore connector used by the job. |
| 300 | "projectId": "A String", # ProjectId accessed in the connection. |
| 301 | "namespace": "A String", # Namespace used in the connection. |
| 302 | }, |
| 303 | ], |
| 304 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 305 | { # Metadata for a File connector used by the job. |
| 306 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 307 | }, |
| 308 | ], |
| 309 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 310 | { # Metadata for a Spanner connector used by the job. |
| 311 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 312 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 313 | "projectId": "A String", # ProjectId accessed in the connection. |
| 314 | }, |
| 315 | ], |
| 316 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 317 | { # Metadata for a PubSub connector used by the job. |
| 318 | "topic": "A String", # Topic accessed in the connection. |
| 319 | "subscription": "A String", # Subscription used in the connection. |
| 320 | }, |
| 321 | ], |
| 322 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 323 | { # Metadata for a BigTable connector used by the job. |
| 324 | "tableId": "A String", # TableId accessed in the connection. |
| 325 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 326 | "projectId": "A String", # ProjectId accessed in the connection. |
| 327 | }, |
| 328 | ], |
| 329 | }, |
| 330 | "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. |
| 331 | "type": "A String", # The type of Cloud Dataflow job. |
| 332 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 333 | { # A message describing the state of a particular execution stage. |
| 334 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 335 | "executionStageName": "A String", # The name of the execution stage. |
| 336 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 337 | }, |
| 338 | ], |
| 339 | "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])?` |
| 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 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 342 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 343 | "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. |
| 344 | "a_key": "A String", |
| 345 | }, |
| 346 | "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. |
| 347 | "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. |
| 348 | "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. |
| 349 | "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. |
| 350 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 351 | { # 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. |
| 352 | "kind": "A String", # Type of tranform this stage is executing. |
| 353 | "id": "A String", # Dataflow service generated id for this stage. |
| 354 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 355 | { # Description of a transform executed as part of an execution stage. |
| 356 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 357 | "name": "A String", # Dataflow service generated name for this source. |
| 358 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 359 | }, |
| 360 | ], |
| 361 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 362 | "A String", |
| 363 | ], |
| 364 | "outputSource": [ # Output sources for this stage. |
| 365 | { # Description of an input or output of an execution stage. |
| 366 | "name": "A String", # Dataflow service generated name for this source. |
| 367 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 368 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 369 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 370 | }, |
| 371 | ], |
| 372 | "inputSource": [ # Input sources for this stage. |
| 373 | { # Description of an input or output of an execution stage. |
| 374 | "name": "A String", # Dataflow service generated name for this source. |
| 375 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 376 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 377 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 378 | }, |
| 379 | ], |
| 380 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 381 | { # Description of an interstitial value between transforms in an execution stage. |
| 382 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 383 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 384 | "name": "A String", # Dataflow service generated name for this source. |
| 385 | }, |
| 386 | ], |
| 387 | "name": "A String", # Dataflow service generated name for this stage. |
| 388 | }, |
| 389 | ], |
| 390 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 391 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 392 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 393 | "A String", |
| 394 | ], |
| 395 | "id": "A String", # SDK generated id of this transform instance. |
| 396 | "name": "A String", # User provided name for this transform instance. |
| 397 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 398 | "A String", |
| 399 | ], |
| 400 | "kind": "A String", # Type of transform. |
| 401 | "displayData": [ # Transform-specific display data. |
| 402 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 403 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 404 | "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. |
| 405 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 406 | "floatValue": 3.14, # Contains value if the data is of float 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 | "url": "A String", # An optional full URL. |
| 409 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 410 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 411 | "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. |
| 412 | "strValue": "A String", # Contains value if the data is of string type. |
| 413 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 414 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 415 | }, |
| 416 | ], |
| 417 | }, |
| 418 | ], |
| 419 | "displayData": [ # Pipeline level display data. |
| 420 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 421 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 422 | "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. |
| 423 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 424 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 425 | "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. |
| 426 | "url": "A String", # An optional full URL. |
| 427 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 428 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 429 | "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. |
| 430 | "strValue": "A String", # Contains value if the data is of string type. |
| 431 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 432 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 433 | }, |
| 434 | ], |
| 435 | }, |
| 436 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 437 | "a_key": "A String", |
| 438 | }, |
| 439 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 440 | }, |
| 441 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 442 | "failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. |
| 443 | { # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data. |
| 444 | "name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. |
| 445 | }, |
| 446 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 447 | "nextPageToken": "A String", # Set if there may be more results than fit in this response. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 448 | }</pre> |
| 449 | </div> |
| 450 | |
| 451 | <div class="method"> |
| 452 | <code class="details" id="aggregated_next">aggregated_next(previous_request, previous_response)</code> |
| 453 | <pre>Retrieves the next page of results. |
| 454 | |
| 455 | Args: |
| 456 | previous_request: The request for the previous page. (required) |
| 457 | previous_response: The response from the request for the previous page. (required) |
| 458 | |
| 459 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 460 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 461 | page. Returns None if there are no more items in the collection. |
| 462 | </pre> |
| 463 | </div> |
| 464 | |
| 465 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 466 | <code class="details" id="close">close()</code> |
| 467 | <pre>Close httplib2 connections.</pre> |
| 468 | </div> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 469 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 470 | <div class="method"> |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 471 | <code class="details" id="create">create(projectId, body=None, location=None, view=None, replaceJobId=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 472 | <pre>Creates a Cloud Dataflow job. To create a job, we recommend using `projects.locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is not recommended, as your job will always start in `us-central1`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 473 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 474 | Args: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 475 | projectId: string, The ID of the Cloud Platform project that the job belongs to. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 476 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 477 | The object takes the form of: |
| 478 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 479 | { # Defines a job to be run by the Cloud Dataflow service. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 480 | "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. |
| 481 | "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. |
| 482 | { # 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. |
| 483 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 484 | "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. |
| 485 | "a_key": "", # Properties of the object. |
| 486 | }, |
| 487 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 488 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 489 | ], |
| 490 | "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. |
| 491 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 492 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 493 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 494 | "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} |
| 495 | "userAgent": { # A description of the process that generated the request. |
| 496 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 497 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 498 | "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 |
| 499 | "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. |
| 500 | "experiments": [ # The list of experiments to enable. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 501 | "A String", |
| 502 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 503 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 504 | { # 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. |
| 505 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 506 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 507 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 508 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 509 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 510 | "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/" |
| 511 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 512 | "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} |
| 513 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 514 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 515 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 516 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 517 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 518 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 519 | "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} |
| 520 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 521 | "A String", |
| 522 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 523 | "vmId": "A String", # The ID string of the VM. |
| 524 | "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/" |
| 525 | "workflowFileName": "A String", # The file to store the workflow in. |
| 526 | "languageHint": "A String", # The suggested backend language. |
| 527 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 528 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 529 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 530 | "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} |
| 531 | "logDir": "A String", # The directory on the VM to store logs. |
| 532 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 533 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 534 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 535 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 536 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 537 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 538 | "a_key": "A String", |
| 539 | }, |
| 540 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 541 | { # Describes the data disk used by a workflow job. |
| 542 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 543 | "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 |
| 544 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 545 | }, |
| 546 | ], |
| 547 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 548 | "packages": [ # Packages to be installed on workers. |
| 549 | { # 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. |
| 550 | "name": "A String", # The name of the package. |
| 551 | "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/ |
| 552 | }, |
| 553 | ], |
| 554 | "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. |
| 555 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 556 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 557 | "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. |
| 558 | }, |
| 559 | ], |
| 560 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 561 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 562 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 563 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 564 | }, |
| 565 | "teardownPolicy": "A String", # Sets the policy for determining when to turndown worker pool. Allowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and `TEARDOWN_NEVER`. `TEARDOWN_ALWAYS` means workers are always torn down regardless of whether the job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down if the job succeeds. `TEARDOWN_NEVER` means the workers are never torn down. If the workers are not torn down by the service, they will continue to run and use Google Compute Engine VM resources in the user's project until they are explicitly terminated by the user. Because of this, Google recommends using the `TEARDOWN_ALWAYS` policy except for small, manually supervised test jobs. If unknown or unspecified, the service will attempt to choose a reasonable default. |
| 566 | "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. |
| 567 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 568 | "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. |
| 569 | "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. |
| 570 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 571 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 572 | "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). |
| 573 | "poolArgs": { # Extra arguments for this worker pool. |
| 574 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 575 | }, |
| 576 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 577 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 578 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 579 | }, |
| 580 | ], |
| 581 | "internalExperiments": { # Experimental settings. |
| 582 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 583 | }, |
| 584 | "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. |
| 585 | "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". |
| 586 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 587 | "a_key": "", # Properties of the object. |
| 588 | }, |
| 589 | "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. |
| 590 | "a_key": "", # Properties of the object. |
| 591 | }, |
| 592 | "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} |
| 593 | }, |
| 594 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 595 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 596 | "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} |
| 597 | "A String", |
| 598 | ], |
| 599 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 600 | "stages": { # A mapping from each stage to the information about that stage. |
| 601 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 602 | "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. |
| 603 | "A String", |
| 604 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 605 | }, |
| 606 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 607 | }, |
| 608 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 609 | "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. |
| 610 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 611 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 612 | "version": "A String", # The version of the SDK used to run the job. |
| 613 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 614 | }, |
| 615 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 616 | { # Metadata for a BigQuery connector used by the job. |
| 617 | "query": "A String", # Query used to access data in the connection. |
| 618 | "projectId": "A String", # Project accessed in the connection. |
| 619 | "table": "A String", # Table accessed in the connection. |
| 620 | "dataset": "A String", # Dataset accessed in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 621 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 622 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 623 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 624 | { # Metadata for a Datastore connector used by the job. |
| 625 | "projectId": "A String", # ProjectId accessed in the connection. |
| 626 | "namespace": "A String", # Namespace used in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 627 | }, |
| 628 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 629 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 630 | { # Metadata for a File connector used by the job. |
| 631 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 632 | }, |
| 633 | ], |
| 634 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 635 | { # Metadata for a Spanner connector used by the job. |
| 636 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 637 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 638 | "projectId": "A String", # ProjectId accessed in the connection. |
| 639 | }, |
| 640 | ], |
| 641 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 642 | { # Metadata for a PubSub connector used by the job. |
| 643 | "topic": "A String", # Topic accessed in the connection. |
| 644 | "subscription": "A String", # Subscription used in the connection. |
| 645 | }, |
| 646 | ], |
| 647 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 648 | { # Metadata for a BigTable connector used by the job. |
| 649 | "tableId": "A String", # TableId accessed in the connection. |
| 650 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 651 | "projectId": "A String", # ProjectId accessed in the connection. |
| 652 | }, |
| 653 | ], |
| 654 | }, |
| 655 | "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. |
| 656 | "type": "A String", # The type of Cloud Dataflow job. |
| 657 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 658 | { # A message describing the state of a particular execution stage. |
| 659 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 660 | "executionStageName": "A String", # The name of the execution stage. |
| 661 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 662 | }, |
| 663 | ], |
| 664 | "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])?` |
| 665 | "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. |
| 666 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 667 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 668 | "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. |
| 669 | "a_key": "A String", |
| 670 | }, |
| 671 | "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. |
| 672 | "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. |
| 673 | "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| 674 | "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| 675 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 676 | { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| 677 | "kind": "A String", # Type of tranform this stage is executing. |
| 678 | "id": "A String", # Dataflow service generated id for this stage. |
| 679 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 680 | { # Description of a transform executed as part of an execution stage. |
| 681 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 682 | "name": "A String", # Dataflow service generated name for this source. |
| 683 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 684 | }, |
| 685 | ], |
| 686 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 687 | "A String", |
| 688 | ], |
| 689 | "outputSource": [ # Output sources for this stage. |
| 690 | { # Description of an input or output of an execution stage. |
| 691 | "name": "A String", # Dataflow service generated name for this source. |
| 692 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 693 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 694 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 695 | }, |
| 696 | ], |
| 697 | "inputSource": [ # Input sources for this stage. |
| 698 | { # Description of an input or output of an execution stage. |
| 699 | "name": "A String", # Dataflow service generated name for this source. |
| 700 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 701 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 702 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 703 | }, |
| 704 | ], |
| 705 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 706 | { # Description of an interstitial value between transforms in an execution stage. |
| 707 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 708 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 709 | "name": "A String", # Dataflow service generated name for this source. |
| 710 | }, |
| 711 | ], |
| 712 | "name": "A String", # Dataflow service generated name for this stage. |
| 713 | }, |
| 714 | ], |
| 715 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 716 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 717 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 718 | "A String", |
| 719 | ], |
| 720 | "id": "A String", # SDK generated id of this transform instance. |
| 721 | "name": "A String", # User provided name for this transform instance. |
| 722 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 723 | "A String", |
| 724 | ], |
| 725 | "kind": "A String", # Type of transform. |
| 726 | "displayData": [ # Transform-specific display data. |
| 727 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 728 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 729 | "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. |
| 730 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 731 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 732 | "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. |
| 733 | "url": "A String", # An optional full URL. |
| 734 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 735 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 736 | "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. |
| 737 | "strValue": "A String", # Contains value if the data is of string type. |
| 738 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 739 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 740 | }, |
| 741 | ], |
| 742 | }, |
| 743 | ], |
| 744 | "displayData": [ # Pipeline level display data. |
| 745 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 746 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 747 | "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. |
| 748 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 749 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 750 | "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. |
| 751 | "url": "A String", # An optional full URL. |
| 752 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 753 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 754 | "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. |
| 755 | "strValue": "A String", # Contains value if the data is of string type. |
| 756 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 757 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 758 | }, |
| 759 | ], |
| 760 | }, |
| 761 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 762 | "a_key": "A String", |
| 763 | }, |
| 764 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 765 | } |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 766 | |
| 767 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 768 | view: string, The level of information requested in response. |
| 769 | Allowed values |
| 770 | 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. |
| 771 | 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. |
| 772 | JOB_VIEW_ALL - Request all information available for this job. |
| 773 | JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 774 | replaceJobId: string, Deprecated. This field is now in the Job message. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 775 | x__xgafv: string, V1 error format. |
| 776 | Allowed values |
| 777 | 1 - v1 error format |
| 778 | 2 - v2 error format |
| 779 | |
| 780 | Returns: |
| 781 | An object of the form: |
| 782 | |
| 783 | { # Defines a job to be run by the Cloud Dataflow service. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 784 | "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. |
| 785 | "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. |
| 786 | { # 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. |
| 787 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 788 | "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. |
| 789 | "a_key": "", # Properties of the object. |
| 790 | }, |
| 791 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 792 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 793 | ], |
| 794 | "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. |
| 795 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 796 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 797 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 798 | "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} |
| 799 | "userAgent": { # A description of the process that generated the request. |
| 800 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 801 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 802 | "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 |
| 803 | "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. |
| 804 | "experiments": [ # The list of experiments to enable. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 805 | "A String", |
| 806 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 807 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 808 | { # 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. |
| 809 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 810 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 811 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 812 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 813 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 814 | "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/" |
| 815 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 816 | "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} |
| 817 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 818 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 819 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 820 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 821 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 822 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 823 | "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} |
| 824 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 825 | "A String", |
| 826 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 827 | "vmId": "A String", # The ID string of the VM. |
| 828 | "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/" |
| 829 | "workflowFileName": "A String", # The file to store the workflow in. |
| 830 | "languageHint": "A String", # The suggested backend language. |
| 831 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 832 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 833 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 834 | "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} |
| 835 | "logDir": "A String", # The directory on the VM to store logs. |
| 836 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 837 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 838 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 839 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 840 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 841 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 842 | "a_key": "A String", |
| 843 | }, |
| 844 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 845 | { # Describes the data disk used by a workflow job. |
| 846 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 847 | "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 |
| 848 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 849 | }, |
| 850 | ], |
| 851 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 852 | "packages": [ # Packages to be installed on workers. |
| 853 | { # 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. |
| 854 | "name": "A String", # The name of the package. |
| 855 | "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/ |
| 856 | }, |
| 857 | ], |
| 858 | "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. |
| 859 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 860 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 861 | "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. |
| 862 | }, |
| 863 | ], |
| 864 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 865 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 866 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 867 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 868 | }, |
| 869 | "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. |
| 870 | "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. |
| 871 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 872 | "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. |
| 873 | "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. |
| 874 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 875 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 876 | "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). |
| 877 | "poolArgs": { # Extra arguments for this worker pool. |
| 878 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 879 | }, |
| 880 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 881 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 882 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 883 | }, |
| 884 | ], |
| 885 | "internalExperiments": { # Experimental settings. |
| 886 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 887 | }, |
| 888 | "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. |
| 889 | "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". |
| 890 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 891 | "a_key": "", # Properties of the object. |
| 892 | }, |
| 893 | "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. |
| 894 | "a_key": "", # Properties of the object. |
| 895 | }, |
| 896 | "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} |
| 897 | }, |
| 898 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 899 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 900 | "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} |
| 901 | "A String", |
| 902 | ], |
| 903 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 904 | "stages": { # A mapping from each stage to the information about that stage. |
| 905 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 906 | "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. |
| 907 | "A String", |
| 908 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 909 | }, |
| 910 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 911 | }, |
| 912 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 913 | "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. |
| 914 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 915 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 916 | "version": "A String", # The version of the SDK used to run the job. |
| 917 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 918 | }, |
| 919 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 920 | { # Metadata for a BigQuery connector used by the job. |
| 921 | "query": "A String", # Query used to access data in the connection. |
| 922 | "projectId": "A String", # Project accessed in the connection. |
| 923 | "table": "A String", # Table accessed in the connection. |
| 924 | "dataset": "A String", # Dataset accessed in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 925 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 926 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 927 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 928 | { # Metadata for a Datastore connector used by the job. |
| 929 | "projectId": "A String", # ProjectId accessed in the connection. |
| 930 | "namespace": "A String", # Namespace used in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 931 | }, |
| 932 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 933 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 934 | { # Metadata for a File connector used by the job. |
| 935 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 936 | }, |
| 937 | ], |
| 938 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 939 | { # Metadata for a Spanner connector used by the job. |
| 940 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 941 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 942 | "projectId": "A String", # ProjectId accessed in the connection. |
| 943 | }, |
| 944 | ], |
| 945 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 946 | { # Metadata for a PubSub connector used by the job. |
| 947 | "topic": "A String", # Topic accessed in the connection. |
| 948 | "subscription": "A String", # Subscription used in the connection. |
| 949 | }, |
| 950 | ], |
| 951 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 952 | { # Metadata for a BigTable connector used by the job. |
| 953 | "tableId": "A String", # TableId accessed in the connection. |
| 954 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 955 | "projectId": "A String", # ProjectId accessed in the connection. |
| 956 | }, |
| 957 | ], |
| 958 | }, |
| 959 | "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. |
| 960 | "type": "A String", # The type of Cloud Dataflow job. |
| 961 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 962 | { # A message describing the state of a particular execution stage. |
| 963 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 964 | "executionStageName": "A String", # The name of the execution stage. |
| 965 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 966 | }, |
| 967 | ], |
| 968 | "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])?` |
| 969 | "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. |
| 970 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 971 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 972 | "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. |
| 973 | "a_key": "A String", |
| 974 | }, |
| 975 | "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. |
| 976 | "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. |
| 977 | "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| 978 | "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| 979 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 980 | { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| 981 | "kind": "A String", # Type of tranform this stage is executing. |
| 982 | "id": "A String", # Dataflow service generated id for this stage. |
| 983 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 984 | { # Description of a transform executed as part of an execution stage. |
| 985 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 986 | "name": "A String", # Dataflow service generated name for this source. |
| 987 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 988 | }, |
| 989 | ], |
| 990 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 991 | "A String", |
| 992 | ], |
| 993 | "outputSource": [ # Output sources for this stage. |
| 994 | { # Description of an input or output of an execution stage. |
| 995 | "name": "A String", # Dataflow service generated name for this source. |
| 996 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 997 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 998 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 999 | }, |
| 1000 | ], |
| 1001 | "inputSource": [ # Input sources for this stage. |
| 1002 | { # Description of an input or output of an execution stage. |
| 1003 | "name": "A String", # Dataflow service generated name for this source. |
| 1004 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 1005 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 1006 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1007 | }, |
| 1008 | ], |
| 1009 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 1010 | { # Description of an interstitial value between transforms in an execution stage. |
| 1011 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 1012 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1013 | "name": "A String", # Dataflow service generated name for this source. |
| 1014 | }, |
| 1015 | ], |
| 1016 | "name": "A String", # Dataflow service generated name for this stage. |
| 1017 | }, |
| 1018 | ], |
| 1019 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 1020 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 1021 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 1022 | "A String", |
| 1023 | ], |
| 1024 | "id": "A String", # SDK generated id of this transform instance. |
| 1025 | "name": "A String", # User provided name for this transform instance. |
| 1026 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 1027 | "A String", |
| 1028 | ], |
| 1029 | "kind": "A String", # Type of transform. |
| 1030 | "displayData": [ # Transform-specific display data. |
| 1031 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1032 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1033 | "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. |
| 1034 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1035 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1036 | "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. |
| 1037 | "url": "A String", # An optional full URL. |
| 1038 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1039 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1040 | "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. |
| 1041 | "strValue": "A String", # Contains value if the data is of string type. |
| 1042 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1043 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1044 | }, |
| 1045 | ], |
| 1046 | }, |
| 1047 | ], |
| 1048 | "displayData": [ # Pipeline level display data. |
| 1049 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1050 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1051 | "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. |
| 1052 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1053 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1054 | "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. |
| 1055 | "url": "A String", # An optional full URL. |
| 1056 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1057 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1058 | "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. |
| 1059 | "strValue": "A String", # Contains value if the data is of string type. |
| 1060 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1061 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1062 | }, |
| 1063 | ], |
| 1064 | }, |
| 1065 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 1066 | "a_key": "A String", |
| 1067 | }, |
| 1068 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 1069 | }</pre> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1070 | </div> |
| 1071 | |
| 1072 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1073 | <code class="details" id="get">get(projectId, jobId, location=None, view=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1074 | <pre>Gets the state of the specified Cloud Dataflow job. To get the state of a job, we recommend using `projects.locations.jobs.get` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.get` is not recommended, as you can only get the state of jobs that are running in `us-central1`. |
| 1075 | |
| 1076 | Args: |
| 1077 | projectId: string, The ID of the Cloud Platform project that the job belongs to. (required) |
| 1078 | jobId: string, The job ID. (required) |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1079 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1080 | view: string, The level of information requested in response. |
| 1081 | Allowed values |
| 1082 | JOB_VIEW_UNKNOWN - The job view to return isn't specified, or is unknown. Responses will contain at least the `JOB_VIEW_SUMMARY` information, and may contain additional information. |
| 1083 | JOB_VIEW_SUMMARY - Request summary information only: Project ID, Job ID, job name, job type, job status, start/end time, and Cloud SDK version details. |
| 1084 | JOB_VIEW_ALL - Request all information available for this job. |
| 1085 | JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment. |
| 1086 | x__xgafv: string, V1 error format. |
| 1087 | Allowed values |
| 1088 | 1 - v1 error format |
| 1089 | 2 - v2 error format |
| 1090 | |
| 1091 | Returns: |
| 1092 | An object of the form: |
| 1093 | |
| 1094 | { # Defines a job to be run by the Cloud Dataflow service. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1095 | "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. |
| 1096 | "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. |
| 1097 | { # 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. |
| 1098 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 1099 | "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. |
| 1100 | "a_key": "", # Properties of the object. |
| 1101 | }, |
| 1102 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1103 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1104 | ], |
| 1105 | "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. |
| 1106 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 1107 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 1108 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 1109 | "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} |
| 1110 | "userAgent": { # A description of the process that generated the request. |
| 1111 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1112 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1113 | "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 |
| 1114 | "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. |
| 1115 | "experiments": [ # The list of experiments to enable. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1116 | "A String", |
| 1117 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1118 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 1119 | { # 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. |
| 1120 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1121 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 1122 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 1123 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 1124 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 1125 | "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/" |
| 1126 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 1127 | "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} |
| 1128 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1129 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1130 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 1131 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 1132 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 1133 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 1134 | "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} |
| 1135 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1136 | "A String", |
| 1137 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1138 | "vmId": "A String", # The ID string of the VM. |
| 1139 | "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/" |
| 1140 | "workflowFileName": "A String", # The file to store the workflow in. |
| 1141 | "languageHint": "A String", # The suggested backend language. |
| 1142 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 1143 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 1144 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 1145 | "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} |
| 1146 | "logDir": "A String", # The directory on the VM to store logs. |
| 1147 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 1148 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 1149 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1150 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1151 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 1152 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 1153 | "a_key": "A String", |
| 1154 | }, |
| 1155 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 1156 | { # Describes the data disk used by a workflow job. |
| 1157 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1158 | "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 |
| 1159 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 1160 | }, |
| 1161 | ], |
| 1162 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1163 | "packages": [ # Packages to be installed on workers. |
| 1164 | { # 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. |
| 1165 | "name": "A String", # The name of the package. |
| 1166 | "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/ |
| 1167 | }, |
| 1168 | ], |
| 1169 | "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. |
| 1170 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 1171 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 1172 | "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. |
| 1173 | }, |
| 1174 | ], |
| 1175 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 1176 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 1177 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 1178 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 1179 | }, |
| 1180 | "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. |
| 1181 | "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. |
| 1182 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1183 | "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. |
| 1184 | "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. |
| 1185 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 1186 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 1187 | "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). |
| 1188 | "poolArgs": { # Extra arguments for this worker pool. |
| 1189 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1190 | }, |
| 1191 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 1192 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1193 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 1194 | }, |
| 1195 | ], |
| 1196 | "internalExperiments": { # Experimental settings. |
| 1197 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1198 | }, |
| 1199 | "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. |
| 1200 | "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". |
| 1201 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 1202 | "a_key": "", # Properties of the object. |
| 1203 | }, |
| 1204 | "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. |
| 1205 | "a_key": "", # Properties of the object. |
| 1206 | }, |
| 1207 | "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} |
| 1208 | }, |
| 1209 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 1210 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 1211 | "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} |
| 1212 | "A String", |
| 1213 | ], |
| 1214 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 1215 | "stages": { # A mapping from each stage to the information about that stage. |
| 1216 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 1217 | "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. |
| 1218 | "A String", |
| 1219 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1220 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1221 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1222 | }, |
| 1223 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 1224 | "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. |
| 1225 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 1226 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 1227 | "version": "A String", # The version of the SDK used to run the job. |
| 1228 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 1229 | }, |
| 1230 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 1231 | { # Metadata for a BigQuery connector used by the job. |
| 1232 | "query": "A String", # Query used to access data in the connection. |
| 1233 | "projectId": "A String", # Project accessed in the connection. |
| 1234 | "table": "A String", # Table accessed in the connection. |
| 1235 | "dataset": "A String", # Dataset accessed in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1236 | }, |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1237 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1238 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 1239 | { # Metadata for a Datastore connector used by the job. |
| 1240 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1241 | "namespace": "A String", # Namespace used in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1242 | }, |
| 1243 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1244 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 1245 | { # Metadata for a File connector used by the job. |
| 1246 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 1247 | }, |
| 1248 | ], |
| 1249 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 1250 | { # Metadata for a Spanner connector used by the job. |
| 1251 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1252 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 1253 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1254 | }, |
| 1255 | ], |
| 1256 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 1257 | { # Metadata for a PubSub connector used by the job. |
| 1258 | "topic": "A String", # Topic accessed in the connection. |
| 1259 | "subscription": "A String", # Subscription used in the connection. |
| 1260 | }, |
| 1261 | ], |
| 1262 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 1263 | { # Metadata for a BigTable connector used by the job. |
| 1264 | "tableId": "A String", # TableId accessed in the connection. |
| 1265 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1266 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1267 | }, |
| 1268 | ], |
| 1269 | }, |
| 1270 | "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. |
| 1271 | "type": "A String", # The type of Cloud Dataflow job. |
| 1272 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 1273 | { # A message describing the state of a particular execution stage. |
| 1274 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 1275 | "executionStageName": "A String", # The name of the execution stage. |
| 1276 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 1277 | }, |
| 1278 | ], |
| 1279 | "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])?` |
| 1280 | "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. |
| 1281 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 1282 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 1283 | "labels": { # User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. |
| 1284 | "a_key": "A String", |
| 1285 | }, |
| 1286 | "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. |
| 1287 | "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. |
| 1288 | "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| 1289 | "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| 1290 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 1291 | { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| 1292 | "kind": "A String", # Type of tranform this stage is executing. |
| 1293 | "id": "A String", # Dataflow service generated id for this stage. |
| 1294 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 1295 | { # Description of a transform executed as part of an execution stage. |
| 1296 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 1297 | "name": "A String", # Dataflow service generated name for this source. |
| 1298 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 1299 | }, |
| 1300 | ], |
| 1301 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 1302 | "A String", |
| 1303 | ], |
| 1304 | "outputSource": [ # Output sources for this stage. |
| 1305 | { # Description of an input or output of an execution stage. |
| 1306 | "name": "A String", # Dataflow service generated name for this source. |
| 1307 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 1308 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 1309 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1310 | }, |
| 1311 | ], |
| 1312 | "inputSource": [ # Input sources for this stage. |
| 1313 | { # Description of an input or output of an execution stage. |
| 1314 | "name": "A String", # Dataflow service generated name for this source. |
| 1315 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 1316 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 1317 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1318 | }, |
| 1319 | ], |
| 1320 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 1321 | { # Description of an interstitial value between transforms in an execution stage. |
| 1322 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 1323 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1324 | "name": "A String", # Dataflow service generated name for this source. |
| 1325 | }, |
| 1326 | ], |
| 1327 | "name": "A String", # Dataflow service generated name for this stage. |
| 1328 | }, |
| 1329 | ], |
| 1330 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 1331 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 1332 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 1333 | "A String", |
| 1334 | ], |
| 1335 | "id": "A String", # SDK generated id of this transform instance. |
| 1336 | "name": "A String", # User provided name for this transform instance. |
| 1337 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 1338 | "A String", |
| 1339 | ], |
| 1340 | "kind": "A String", # Type of transform. |
| 1341 | "displayData": [ # Transform-specific display data. |
| 1342 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1343 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1344 | "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. |
| 1345 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1346 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1347 | "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. |
| 1348 | "url": "A String", # An optional full URL. |
| 1349 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1350 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1351 | "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. |
| 1352 | "strValue": "A String", # Contains value if the data is of string type. |
| 1353 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1354 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1355 | }, |
| 1356 | ], |
| 1357 | }, |
| 1358 | ], |
| 1359 | "displayData": [ # Pipeline level display data. |
| 1360 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1361 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1362 | "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. |
| 1363 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1364 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1365 | "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. |
| 1366 | "url": "A String", # An optional full URL. |
| 1367 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1368 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1369 | "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. |
| 1370 | "strValue": "A String", # Contains value if the data is of string type. |
| 1371 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1372 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1373 | }, |
| 1374 | ], |
| 1375 | }, |
| 1376 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 1377 | "a_key": "A String", |
| 1378 | }, |
| 1379 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 1380 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1381 | </div> |
| 1382 | |
| 1383 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1384 | <code class="details" id="getMetrics">getMetrics(projectId, jobId, startTime=None, location=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1385 | <pre>Request the job status. To request the status of a job, we recommend using `projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.getMetrics` is not recommended, as you can only request the status of jobs that are running in `us-central1`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1386 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1387 | Args: |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1388 | projectId: string, A project id. (required) |
| 1389 | jobId: string, The job to get metrics for. (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1390 | startTime: string, Return only metric data that has changed since this time. Default is to return all information about all metrics for the job. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1391 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. |
| Takashi Matsuo | 0669410 | 2015-09-11 13:55:40 -0700 | [diff] [blame] | 1392 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1393 | Allowed values |
| 1394 | 1 - v1 error format |
| 1395 | 2 - v2 error format |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1396 | |
| 1397 | Returns: |
| 1398 | An object of the form: |
| 1399 | |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1400 | { # JobMetrics contains a collection of metrics describing the detailed progress of a Dataflow job. Metrics correspond to user-defined and system-defined metrics in the job. This resource captures only the most recent values of each metric; time-series data can be queried for them (under the same metric names) from Cloud Monitoring. |
| 1401 | "metrics": [ # All metrics for this job. |
| 1402 | { # Describes the state of a metric. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1403 | "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. |
| 1404 | "internal": "", # Worker-computed aggregate value for internal use by the Dataflow service. |
| 1405 | "meanSum": "", # Worker-computed aggregate value for the "Mean" aggregation kind. This holds the sum of the aggregated values and is used in combination with mean_count below to obtain the actual mean aggregate value. The only possible value types are Long and Double. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1406 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1407 | "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. |
| 1408 | "distribution": "", # A struct value describing properties of a distribution of numeric values. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1409 | "name": { # Identifies a metric, by describing the source which generated the metric. # Name of the metric. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1410 | "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 | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1411 | "a_key": "A String", |
| 1412 | }, |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1413 | "name": "A String", # Worker-defined metric name. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1414 | "origin": "A String", # Origin (namespace) of metric name. May be blank for user-define metrics; will be "dataflow" for metrics defined by the Dataflow service or SDK. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1415 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1416 | "scalar": "", # Worker-computed aggregate value for aggregation kinds "Sum", "Max", "Min", "And", and "Or". The possible value types are Long, Double, and Boolean. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1417 | "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. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1418 | "cumulative": True or False, # True if this metric is reported as the total cumulative aggregate value accumulated since the worker started working on this WorkItem. By default this is false, indicating that this metric is reported as a delta that is not associated with any WorkItem. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1419 | "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. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1420 | }, |
| 1421 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1422 | "metricTime": "A String", # Timestamp as of which metric values are current. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1423 | }</pre> |
| 1424 | </div> |
| 1425 | |
| 1426 | <div class="method"> |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1427 | <code class="details" id="list">list(projectId, view=None, pageSize=None, location=None, pageToken=None, filter=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1428 | <pre>List the jobs of a project. To list the jobs of a project in a region, we recommend using `projects.locations.jobs.list` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list the all jobs across all regions, use `projects.jobs.aggregated`. Using `projects.jobs.list` is not recommended, as you can only get the list of jobs that are running in `us-central1`. |
| 1429 | |
| 1430 | Args: |
| 1431 | projectId: string, The project which owns the jobs. (required) |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1432 | view: string, Level of information requested in response. Default is `JOB_VIEW_SUMMARY`. |
| 1433 | Allowed values |
| 1434 | 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. |
| 1435 | 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. |
| 1436 | JOB_VIEW_ALL - Request all information available for this job. |
| 1437 | JOB_VIEW_DESCRIPTION - Request summary info and limited job description data for steps, labels and environment. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1438 | 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. |
| 1439 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1440 | pageToken: string, Set this to the 'next_page_token' field of a previous response to request additional results in a long list. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1441 | filter: string, The kind of filter to use. |
| 1442 | Allowed values |
| 1443 | UNKNOWN - The filter isn't specified, or is unknown. This returns all jobs ordered on descending `JobUuid`. |
| 1444 | ALL - Returns all running jobs first ordered on creation timestamp, then returns all terminated jobs ordered on the termination timestamp. |
| 1445 | 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. |
| 1446 | ACTIVE - Filters the jobs that are running ordered on the creation timestamp. |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1447 | x__xgafv: string, V1 error format. |
| 1448 | Allowed values |
| 1449 | 1 - v1 error format |
| 1450 | 2 - v2 error format |
| 1451 | |
| 1452 | Returns: |
| 1453 | An object of the form: |
| 1454 | |
| 1455 | { # Response to a request to list Cloud Dataflow jobs in a project. This might be a partial response, depending on the page size in the ListJobsRequest. However, if the project does not have any jobs, an instance of ListJobsResponse is not returned and the requests's response body is empty {}. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1456 | "jobs": [ # A subset of the requested job information. |
| 1457 | { # Defines a job to be run by the Cloud Dataflow service. |
| 1458 | "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. |
| 1459 | "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. |
| 1460 | { # 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. |
| 1461 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 1462 | "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. |
| 1463 | "a_key": "", # Properties of the object. |
| 1464 | }, |
| 1465 | "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. |
| 1466 | }, |
| 1467 | ], |
| 1468 | "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. |
| 1469 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 1470 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 1471 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 1472 | "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} |
| 1473 | "userAgent": { # A description of the process that generated the request. |
| 1474 | "a_key": "", # Properties of the object. |
| 1475 | }, |
| 1476 | "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 |
| 1477 | "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. |
| 1478 | "experiments": [ # The list of experiments to enable. |
| 1479 | "A String", |
| 1480 | ], |
| 1481 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 1482 | { # 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. |
| 1483 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1484 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 1485 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 1486 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 1487 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 1488 | "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/" |
| 1489 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 1490 | "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} |
| 1491 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| 1492 | }, |
| 1493 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 1494 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 1495 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 1496 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 1497 | "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} |
| 1498 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| 1499 | "A String", |
| 1500 | ], |
| 1501 | "vmId": "A String", # The ID string of the VM. |
| 1502 | "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/" |
| 1503 | "workflowFileName": "A String", # The file to store the workflow in. |
| 1504 | "languageHint": "A String", # The suggested backend language. |
| 1505 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 1506 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 1507 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 1508 | "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} |
| 1509 | "logDir": "A String", # The directory on the VM to store logs. |
| 1510 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 1511 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 1512 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| 1513 | }, |
| 1514 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 1515 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 1516 | "a_key": "A String", |
| 1517 | }, |
| 1518 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 1519 | { # Describes the data disk used by a workflow job. |
| 1520 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1521 | "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 |
| 1522 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 1523 | }, |
| 1524 | ], |
| 1525 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1526 | "packages": [ # Packages to be installed on workers. |
| 1527 | { # 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. |
| 1528 | "name": "A String", # The name of the package. |
| 1529 | "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/ |
| 1530 | }, |
| 1531 | ], |
| 1532 | "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. |
| 1533 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 1534 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 1535 | "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. |
| 1536 | }, |
| 1537 | ], |
| 1538 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 1539 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 1540 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 1541 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 1542 | }, |
| 1543 | "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. |
| 1544 | "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. |
| 1545 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1546 | "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. |
| 1547 | "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. |
| 1548 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 1549 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 1550 | "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). |
| 1551 | "poolArgs": { # Extra arguments for this worker pool. |
| 1552 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1553 | }, |
| 1554 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 1555 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1556 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 1557 | }, |
| 1558 | ], |
| 1559 | "internalExperiments": { # Experimental settings. |
| 1560 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1561 | }, |
| 1562 | "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. |
| 1563 | "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". |
| 1564 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 1565 | "a_key": "", # Properties of the object. |
| 1566 | }, |
| 1567 | "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. |
| 1568 | "a_key": "", # Properties of the object. |
| 1569 | }, |
| 1570 | "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} |
| 1571 | }, |
| 1572 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 1573 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 1574 | "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} |
| 1575 | "A String", |
| 1576 | ], |
| 1577 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 1578 | "stages": { # A mapping from each stage to the information about that stage. |
| 1579 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 1580 | "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. |
| 1581 | "A String", |
| 1582 | ], |
| 1583 | }, |
| 1584 | }, |
| 1585 | }, |
| 1586 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 1587 | "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. |
| 1588 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 1589 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 1590 | "version": "A String", # The version of the SDK used to run the job. |
| 1591 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 1592 | }, |
| 1593 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 1594 | { # Metadata for a BigQuery connector used by the job. |
| 1595 | "query": "A String", # Query used to access data in the connection. |
| 1596 | "projectId": "A String", # Project accessed in the connection. |
| 1597 | "table": "A String", # Table accessed in the connection. |
| 1598 | "dataset": "A String", # Dataset accessed in the connection. |
| 1599 | }, |
| 1600 | ], |
| 1601 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 1602 | { # Metadata for a Datastore connector used by the job. |
| 1603 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1604 | "namespace": "A String", # Namespace used in the connection. |
| 1605 | }, |
| 1606 | ], |
| 1607 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 1608 | { # Metadata for a File connector used by the job. |
| 1609 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 1610 | }, |
| 1611 | ], |
| 1612 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 1613 | { # Metadata for a Spanner connector used by the job. |
| 1614 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1615 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 1616 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1617 | }, |
| 1618 | ], |
| 1619 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 1620 | { # Metadata for a PubSub connector used by the job. |
| 1621 | "topic": "A String", # Topic accessed in the connection. |
| 1622 | "subscription": "A String", # Subscription used in the connection. |
| 1623 | }, |
| 1624 | ], |
| 1625 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 1626 | { # Metadata for a BigTable connector used by the job. |
| 1627 | "tableId": "A String", # TableId accessed in the connection. |
| 1628 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1629 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1630 | }, |
| 1631 | ], |
| 1632 | }, |
| 1633 | "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. |
| 1634 | "type": "A String", # The type of Cloud Dataflow job. |
| 1635 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 1636 | { # A message describing the state of a particular execution stage. |
| 1637 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 1638 | "executionStageName": "A String", # The name of the execution stage. |
| 1639 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 1640 | }, |
| 1641 | ], |
| 1642 | "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])?` |
| 1643 | "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. |
| 1644 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 1645 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 1646 | "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. |
| 1647 | "a_key": "A String", |
| 1648 | }, |
| 1649 | "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. |
| 1650 | "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. |
| 1651 | "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. |
| 1652 | "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. |
| 1653 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 1654 | { # 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. |
| 1655 | "kind": "A String", # Type of tranform this stage is executing. |
| 1656 | "id": "A String", # Dataflow service generated id for this stage. |
| 1657 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 1658 | { # Description of a transform executed as part of an execution stage. |
| 1659 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 1660 | "name": "A String", # Dataflow service generated name for this source. |
| 1661 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 1662 | }, |
| 1663 | ], |
| 1664 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 1665 | "A String", |
| 1666 | ], |
| 1667 | "outputSource": [ # Output sources for this stage. |
| 1668 | { # Description of an input or output of an execution stage. |
| 1669 | "name": "A String", # Dataflow service generated name for this source. |
| 1670 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 1671 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 1672 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1673 | }, |
| 1674 | ], |
| 1675 | "inputSource": [ # Input sources for this stage. |
| 1676 | { # Description of an input or output of an execution stage. |
| 1677 | "name": "A String", # Dataflow service generated name for this source. |
| 1678 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 1679 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 1680 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1681 | }, |
| 1682 | ], |
| 1683 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 1684 | { # Description of an interstitial value between transforms in an execution stage. |
| 1685 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 1686 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 1687 | "name": "A String", # Dataflow service generated name for this source. |
| 1688 | }, |
| 1689 | ], |
| 1690 | "name": "A String", # Dataflow service generated name for this stage. |
| 1691 | }, |
| 1692 | ], |
| 1693 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 1694 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 1695 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 1696 | "A String", |
| 1697 | ], |
| 1698 | "id": "A String", # SDK generated id of this transform instance. |
| 1699 | "name": "A String", # User provided name for this transform instance. |
| 1700 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 1701 | "A String", |
| 1702 | ], |
| 1703 | "kind": "A String", # Type of transform. |
| 1704 | "displayData": [ # Transform-specific display data. |
| 1705 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1706 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1707 | "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. |
| 1708 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1709 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1710 | "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. |
| 1711 | "url": "A String", # An optional full URL. |
| 1712 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1713 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1714 | "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. |
| 1715 | "strValue": "A String", # Contains value if the data is of string type. |
| 1716 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1717 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1718 | }, |
| 1719 | ], |
| 1720 | }, |
| 1721 | ], |
| 1722 | "displayData": [ # Pipeline level display data. |
| 1723 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 1724 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 1725 | "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. |
| 1726 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 1727 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 1728 | "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. |
| 1729 | "url": "A String", # An optional full URL. |
| 1730 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 1731 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 1732 | "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. |
| 1733 | "strValue": "A String", # Contains value if the data is of string type. |
| 1734 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 1735 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 1736 | }, |
| 1737 | ], |
| 1738 | }, |
| 1739 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 1740 | "a_key": "A String", |
| 1741 | }, |
| 1742 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 1743 | }, |
| 1744 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1745 | "failedLocation": [ # Zero or more messages describing the [regional endpoints] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. |
| 1746 | { # Indicates which [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) failed to respond to a request for data. |
| 1747 | "name": "A String", # The name of the [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that failed to respond. |
| 1748 | }, |
| 1749 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1750 | "nextPageToken": "A String", # Set if there may be more results than fit in this response. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1751 | }</pre> |
| 1752 | </div> |
| 1753 | |
| 1754 | <div class="method"> |
| 1755 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1756 | <pre>Retrieves the next page of results. |
| 1757 | |
| 1758 | Args: |
| 1759 | previous_request: The request for the previous page. (required) |
| 1760 | previous_response: The response from the request for the previous page. (required) |
| 1761 | |
| 1762 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1763 | A request object that you can call 'execute()' on to request the next |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1764 | page. Returns None if there are no more items in the collection. |
| 1765 | </pre> |
| 1766 | </div> |
| 1767 | |
| 1768 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1769 | <code class="details" id="snapshot">snapshot(projectId, jobId, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1770 | <pre>Snapshot the state of a streaming job. |
| 1771 | |
| 1772 | Args: |
| 1773 | projectId: string, The project which owns the job to be snapshotted. (required) |
| 1774 | jobId: string, The job to be snapshotted. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1775 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1776 | The object takes the form of: |
| 1777 | |
| 1778 | { # Request to create a snapshot of a job. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1779 | "ttl": "A String", # TTL for the snapshot. |
| 1780 | "location": "A String", # The location that contains this job. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1781 | "description": "A String", # User specified description of the snapshot. Maybe empty. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1782 | "snapshotSources": True or False, # If true, perform snapshots for sources which support this. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1783 | } |
| 1784 | |
| 1785 | x__xgafv: string, V1 error format. |
| 1786 | Allowed values |
| 1787 | 1 - v1 error format |
| 1788 | 2 - v2 error format |
| 1789 | |
| 1790 | Returns: |
| 1791 | An object of the form: |
| 1792 | |
| 1793 | { # Represents a snapshot of a job. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1794 | "pubsubMetadata": [ # PubSub snapshot metadata. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1795 | { # Represents a Pubsub snapshot. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1796 | "snapshotName": "A String", # The name of the Pubsub snapshot. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1797 | "topicName": "A String", # The name of the Pubsub topic. |
| 1798 | "expireTime": "A String", # The expire time of the Pubsub snapshot. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1799 | }, |
| 1800 | ], |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1801 | "creationTime": "A String", # The time this snapshot was created. |
| 1802 | "id": "A String", # The unique ID of this snapshot. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1803 | "diskSizeBytes": "A String", # The disk byte size of the snapshot. Only available for snapshots in READY state. |
| 1804 | "projectId": "A String", # The project this snapshot belongs to. |
| 1805 | "state": "A String", # State of the snapshot. |
| 1806 | "ttl": "A String", # The time after which this snapshot will be automatically deleted. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1807 | "description": "A String", # User specified description of the snapshot. Maybe empty. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1808 | "sourceJobId": "A String", # The job this snapshot was created from. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1809 | }</pre> |
| 1810 | </div> |
| 1811 | |
| 1812 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1813 | <code class="details" id="update">update(projectId, jobId, body=None, location=None, x__xgafv=None)</code> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 1814 | <pre>Updates the state of an existing Cloud Dataflow job. To update the state of an existing job, we recommend using `projects.locations.jobs.update` with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.update` is not recommended, as you can only update the state of jobs that are running in `us-central1`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1815 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1816 | Args: |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1817 | projectId: string, The ID of the Cloud Platform project that the job belongs to. (required) |
| 1818 | jobId: string, The job ID. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1819 | body: object, The request body. |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 1820 | The object takes the form of: |
| 1821 | |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1822 | { # Defines a job to be run by the Cloud Dataflow service. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1823 | "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. |
| 1824 | "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. |
| 1825 | { # 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. |
| 1826 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 1827 | "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. |
| 1828 | "a_key": "", # Properties of the object. |
| 1829 | }, |
| 1830 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1831 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1832 | ], |
| 1833 | "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. |
| 1834 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 1835 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 1836 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 1837 | "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} |
| 1838 | "userAgent": { # A description of the process that generated the request. |
| 1839 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1840 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1841 | "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 |
| 1842 | "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. |
| 1843 | "experiments": [ # The list of experiments to enable. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1844 | "A String", |
| 1845 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1846 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 1847 | { # 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. |
| 1848 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1849 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 1850 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 1851 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 1852 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 1853 | "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/" |
| 1854 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 1855 | "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} |
| 1856 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1857 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1858 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 1859 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 1860 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 1861 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 1862 | "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} |
| 1863 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1864 | "A String", |
| 1865 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1866 | "vmId": "A String", # The ID string of the VM. |
| 1867 | "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/" |
| 1868 | "workflowFileName": "A String", # The file to store the workflow in. |
| 1869 | "languageHint": "A String", # The suggested backend language. |
| 1870 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 1871 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 1872 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 1873 | "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} |
| 1874 | "logDir": "A String", # The directory on the VM to store logs. |
| 1875 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 1876 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 1877 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1878 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1879 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 1880 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 1881 | "a_key": "A String", |
| 1882 | }, |
| 1883 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 1884 | { # Describes the data disk used by a workflow job. |
| 1885 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1886 | "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 |
| 1887 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 1888 | }, |
| 1889 | ], |
| 1890 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1891 | "packages": [ # Packages to be installed on workers. |
| 1892 | { # 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. |
| 1893 | "name": "A String", # The name of the package. |
| 1894 | "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/ |
| 1895 | }, |
| 1896 | ], |
| 1897 | "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. |
| 1898 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 1899 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 1900 | "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. |
| 1901 | }, |
| 1902 | ], |
| 1903 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 1904 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 1905 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 1906 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 1907 | }, |
| 1908 | "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. |
| 1909 | "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. |
| 1910 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 1911 | "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. |
| 1912 | "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. |
| 1913 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 1914 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 1915 | "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). |
| 1916 | "poolArgs": { # Extra arguments for this worker pool. |
| 1917 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1918 | }, |
| 1919 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 1920 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 1921 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 1922 | }, |
| 1923 | ], |
| 1924 | "internalExperiments": { # Experimental settings. |
| 1925 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 1926 | }, |
| 1927 | "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. |
| 1928 | "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". |
| 1929 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 1930 | "a_key": "", # Properties of the object. |
| 1931 | }, |
| 1932 | "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. |
| 1933 | "a_key": "", # Properties of the object. |
| 1934 | }, |
| 1935 | "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} |
| 1936 | }, |
| 1937 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 1938 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 1939 | "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} |
| 1940 | "A String", |
| 1941 | ], |
| 1942 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 1943 | "stages": { # A mapping from each stage to the information about that stage. |
| 1944 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 1945 | "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. |
| 1946 | "A String", |
| 1947 | ], |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 1948 | }, |
| 1949 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1950 | }, |
| 1951 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 1952 | "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. |
| 1953 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 1954 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 1955 | "version": "A String", # The version of the SDK used to run the job. |
| 1956 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 1957 | }, |
| 1958 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 1959 | { # Metadata for a BigQuery connector used by the job. |
| 1960 | "query": "A String", # Query used to access data in the connection. |
| 1961 | "projectId": "A String", # Project accessed in the connection. |
| 1962 | "table": "A String", # Table accessed in the connection. |
| 1963 | "dataset": "A String", # Dataset accessed in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1964 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 1965 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1966 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 1967 | { # Metadata for a Datastore connector used by the job. |
| 1968 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1969 | "namespace": "A String", # Namespace used in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 1970 | }, |
| 1971 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 1972 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 1973 | { # Metadata for a File connector used by the job. |
| 1974 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 1975 | }, |
| 1976 | ], |
| 1977 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 1978 | { # Metadata for a Spanner connector used by the job. |
| 1979 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1980 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 1981 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1982 | }, |
| 1983 | ], |
| 1984 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 1985 | { # Metadata for a PubSub connector used by the job. |
| 1986 | "topic": "A String", # Topic accessed in the connection. |
| 1987 | "subscription": "A String", # Subscription used in the connection. |
| 1988 | }, |
| 1989 | ], |
| 1990 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 1991 | { # Metadata for a BigTable connector used by the job. |
| 1992 | "tableId": "A String", # TableId accessed in the connection. |
| 1993 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 1994 | "projectId": "A String", # ProjectId accessed in the connection. |
| 1995 | }, |
| 1996 | ], |
| 1997 | }, |
| 1998 | "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. |
| 1999 | "type": "A String", # The type of Cloud Dataflow job. |
| 2000 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 2001 | { # A message describing the state of a particular execution stage. |
| 2002 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 2003 | "executionStageName": "A String", # The name of the execution stage. |
| 2004 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 2005 | }, |
| 2006 | ], |
| 2007 | "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])?` |
| 2008 | "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. |
| 2009 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 2010 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 2011 | "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. |
| 2012 | "a_key": "A String", |
| 2013 | }, |
| 2014 | "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. |
| 2015 | "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. |
| 2016 | "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| 2017 | "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| 2018 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 2019 | { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| 2020 | "kind": "A String", # Type of tranform this stage is executing. |
| 2021 | "id": "A String", # Dataflow service generated id for this stage. |
| 2022 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 2023 | { # Description of a transform executed as part of an execution stage. |
| 2024 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 2025 | "name": "A String", # Dataflow service generated name for this source. |
| 2026 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 2027 | }, |
| 2028 | ], |
| 2029 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 2030 | "A String", |
| 2031 | ], |
| 2032 | "outputSource": [ # Output sources for this stage. |
| 2033 | { # Description of an input or output of an execution stage. |
| 2034 | "name": "A String", # Dataflow service generated name for this source. |
| 2035 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 2036 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 2037 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2038 | }, |
| 2039 | ], |
| 2040 | "inputSource": [ # Input sources for this stage. |
| 2041 | { # Description of an input or output of an execution stage. |
| 2042 | "name": "A String", # Dataflow service generated name for this source. |
| 2043 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 2044 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 2045 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2046 | }, |
| 2047 | ], |
| 2048 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 2049 | { # Description of an interstitial value between transforms in an execution stage. |
| 2050 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 2051 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2052 | "name": "A String", # Dataflow service generated name for this source. |
| 2053 | }, |
| 2054 | ], |
| 2055 | "name": "A String", # Dataflow service generated name for this stage. |
| 2056 | }, |
| 2057 | ], |
| 2058 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 2059 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 2060 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 2061 | "A String", |
| 2062 | ], |
| 2063 | "id": "A String", # SDK generated id of this transform instance. |
| 2064 | "name": "A String", # User provided name for this transform instance. |
| 2065 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 2066 | "A String", |
| 2067 | ], |
| 2068 | "kind": "A String", # Type of transform. |
| 2069 | "displayData": [ # Transform-specific display data. |
| 2070 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 2071 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 2072 | "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. |
| 2073 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 2074 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 2075 | "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. |
| 2076 | "url": "A String", # An optional full URL. |
| 2077 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 2078 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 2079 | "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. |
| 2080 | "strValue": "A String", # Contains value if the data is of string type. |
| 2081 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 2082 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 2083 | }, |
| 2084 | ], |
| 2085 | }, |
| 2086 | ], |
| 2087 | "displayData": [ # Pipeline level display data. |
| 2088 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 2089 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 2090 | "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. |
| 2091 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 2092 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 2093 | "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. |
| 2094 | "url": "A String", # An optional full URL. |
| 2095 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 2096 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 2097 | "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. |
| 2098 | "strValue": "A String", # Contains value if the data is of string type. |
| 2099 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 2100 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 2101 | }, |
| 2102 | ], |
| 2103 | }, |
| 2104 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 2105 | "a_key": "A String", |
| 2106 | }, |
| 2107 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 2108 | } |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2109 | |
| 2110 | location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 2111 | x__xgafv: string, V1 error format. |
| 2112 | Allowed values |
| 2113 | 1 - v1 error format |
| 2114 | 2 - v2 error format |
| 2115 | |
| 2116 | Returns: |
| 2117 | An object of the form: |
| 2118 | |
| 2119 | { # Defines a job to be run by the Cloud Dataflow service. |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2120 | "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. |
| 2121 | "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. |
| 2122 | { # 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. |
| 2123 | "kind": "A String", # The kind of step in the Cloud Dataflow job. |
| 2124 | "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. |
| 2125 | "a_key": "", # Properties of the object. |
| 2126 | }, |
| 2127 | "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. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2128 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2129 | ], |
| 2130 | "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. |
| 2131 | "environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job. |
| 2132 | "flexResourceSchedulingGoal": "A String", # Which Flexible Resource Scheduling mode to run in. |
| 2133 | "serviceAccountEmail": "A String", # Identity to run virtual machines as. Defaults to the default account. |
| 2134 | "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} |
| 2135 | "userAgent": { # A description of the process that generated the request. |
| 2136 | "a_key": "", # Properties of the object. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2137 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2138 | "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 |
| 2139 | "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. |
| 2140 | "experiments": [ # The list of experiments to enable. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2141 | "A String", |
| 2142 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2143 | "workerPools": [ # The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. |
| 2144 | { # 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. |
| 2145 | "machineType": "A String", # Machine type (e.g. "n1-standard-1"). If empty or unspecified, the service will attempt to choose a reasonable default. |
| 2146 | "taskrunnerSettings": { # Taskrunner configuration settings. # Settings passed through to Google Compute Engine workers when using the standard Dataflow task runner. Users should ignore this field. |
| 2147 | "parallelWorkerSettings": { # Provides data to pass through to the worker harness. # The settings to pass to the parallel worker harness. |
| 2148 | "workerId": "A String", # The ID of the worker running this pipeline. |
| 2149 | "reportingEnabled": True or False, # Whether to send work progress updates to the service. |
| 2150 | "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/" |
| 2151 | "shuffleServicePath": "A String", # The Shuffle service path relative to the root URL, for example, "shuffle/v1beta1". |
| 2152 | "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} |
| 2153 | "servicePath": "A String", # The Cloud Dataflow service path relative to the root URL, for example, "dataflow/v1b3/projects". |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2154 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2155 | "logToSerialconsole": True or False, # Whether to send taskrunner log info to Google Compute Engine VM serial console. |
| 2156 | "dataflowApiVersion": "A String", # The API version of endpoint, e.g. "v1b3" |
| 2157 | "commandlinesFileName": "A String", # The file to store preprocessing commands in. |
| 2158 | "taskUser": "A String", # The UNIX user ID on the worker VM to use for tasks launched by taskrunner; e.g. "root". |
| 2159 | "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} |
| 2160 | "oauthScopes": [ # The OAuth2 scopes to be requested by the taskrunner in order to access the Cloud Dataflow API. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2161 | "A String", |
| 2162 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2163 | "vmId": "A String", # The ID string of the VM. |
| 2164 | "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/" |
| 2165 | "workflowFileName": "A String", # The file to store the workflow in. |
| 2166 | "languageHint": "A String", # The suggested backend language. |
| 2167 | "alsologtostderr": True or False, # Whether to also send taskrunner log info to stderr. |
| 2168 | "streamingWorkerMainClass": "A String", # The streaming worker main class name. |
| 2169 | "harnessCommand": "A String", # The command to launch the worker harness. |
| 2170 | "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} |
| 2171 | "logDir": "A String", # The directory on the VM to store logs. |
| 2172 | "continueOnException": True or False, # Whether to continue taskrunner if an exception is hit. |
| 2173 | "taskGroup": "A String", # The UNIX group ID on the worker VM to use for tasks launched by taskrunner; e.g. "wheel". |
| 2174 | "baseTaskDir": "A String", # The location on the worker for task-specific subdirectories. |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2175 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2176 | "diskSourceImage": "A String", # Fully qualified source image for disks. |
| 2177 | "metadata": { # Metadata to set on the Google Compute Engine VMs. |
| 2178 | "a_key": "A String", |
| 2179 | }, |
| 2180 | "dataDisks": [ # Data disks that are used by a VM in this workflow. |
| 2181 | { # Describes the data disk used by a workflow job. |
| 2182 | "sizeGb": 42, # Size of disk in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 2183 | "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 |
| 2184 | "mountPoint": "A String", # Directory in a VM where disk is mounted. |
| 2185 | }, |
| 2186 | ], |
| 2187 | "zone": "A String", # Zone to run the worker pools in. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 2188 | "packages": [ # Packages to be installed on workers. |
| 2189 | { # 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. |
| 2190 | "name": "A String", # The name of the package. |
| 2191 | "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/ |
| 2192 | }, |
| 2193 | ], |
| 2194 | "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. |
| 2195 | { # Defines a SDK harness container for executing Dataflow pipelines. |
| 2196 | "containerImage": "A String", # A docker container image that resides in Google Container Registry. |
| 2197 | "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. |
| 2198 | }, |
| 2199 | ], |
| 2200 | "kind": "A String", # The kind of the worker pool; currently only `harness` and `shuffle` are supported. |
| 2201 | "autoscalingSettings": { # Settings for WorkerPool autoscaling. # Settings for autoscaling of this WorkerPool. |
| 2202 | "algorithm": "A String", # The algorithm to use for autoscaling. |
| 2203 | "maxNumWorkers": 42, # The maximum number of workers to cap scaling at. |
| 2204 | }, |
| 2205 | "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. |
| 2206 | "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. |
| 2207 | "diskSizeGb": 42, # Size of root disk for VMs, in GB. If zero or unspecified, the service will attempt to choose a reasonable default. |
| 2208 | "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. |
| 2209 | "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. |
| 2210 | "onHostMaintenance": "A String", # The action to take on host maintenance, as defined by the Google Compute Engine API. |
| 2211 | "subnetwork": "A String", # Subnetwork to which VMs will be assigned, if desired. Expected to be of the form "regions/REGION/subnetworks/SUBNETWORK". |
| 2212 | "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). |
| 2213 | "poolArgs": { # Extra arguments for this worker pool. |
| 2214 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2215 | }, |
| 2216 | "ipConfiguration": "A String", # Configuration for VM IPs. |
| 2217 | "diskType": "A String", # Type of root disk for VMs. If empty or unspecified, the service will attempt to choose a reasonable default. |
| 2218 | "network": "A String", # Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". |
| 2219 | }, |
| 2220 | ], |
| 2221 | "internalExperiments": { # Experimental settings. |
| 2222 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 2223 | }, |
| 2224 | "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. |
| 2225 | "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". |
| 2226 | "version": { # A structure describing which components and their versions of the service are required in order to run the job. |
| 2227 | "a_key": "", # Properties of the object. |
| 2228 | }, |
| 2229 | "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. |
| 2230 | "a_key": "", # Properties of the object. |
| 2231 | }, |
| 2232 | "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} |
| 2233 | }, |
| 2234 | "projectId": "A String", # The ID of the Cloud Platform project that the job belongs to. |
| 2235 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. |
| 2236 | "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} |
| 2237 | "A String", |
| 2238 | ], |
| 2239 | "executionInfo": { # Additional information about how a Cloud Dataflow job will be executed that isn't contained in the submitted job. # Deprecated. |
| 2240 | "stages": { # A mapping from each stage to the information about that stage. |
| 2241 | "a_key": { # Contains information about how a particular google.dataflow.v1beta3.Step will be executed. |
| 2242 | "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. |
| 2243 | "A String", |
| 2244 | ], |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2245 | }, |
| 2246 | }, |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2247 | }, |
| 2248 | "currentStateTime": "A String", # The timestamp associated with the current state. |
| 2249 | "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. |
| 2250 | "sdkVersion": { # The version of the SDK used to run the job. # The SDK version used to run the job. |
| 2251 | "sdkSupportStatus": "A String", # The support status for this SDK version. |
| 2252 | "version": "A String", # The version of the SDK used to run the job. |
| 2253 | "versionDisplayName": "A String", # A readable string describing the version of the SDK. |
| 2254 | }, |
| 2255 | "bigqueryDetails": [ # Identification of a BigQuery source used in the Dataflow job. |
| 2256 | { # Metadata for a BigQuery connector used by the job. |
| 2257 | "query": "A String", # Query used to access data in the connection. |
| 2258 | "projectId": "A String", # Project accessed in the connection. |
| 2259 | "table": "A String", # Table accessed in the connection. |
| 2260 | "dataset": "A String", # Dataset accessed in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2261 | }, |
| Yoshi Automation Bot | c2228be | 2020-11-24 15:48:03 -0800 | [diff] [blame] | 2262 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2263 | "datastoreDetails": [ # Identification of a Datastore source used in the Dataflow job. |
| 2264 | { # Metadata for a Datastore connector used by the job. |
| 2265 | "projectId": "A String", # ProjectId accessed in the connection. |
| 2266 | "namespace": "A String", # Namespace used in the connection. |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 2267 | }, |
| 2268 | ], |
| Yoshi Automation Bot | b6971b0 | 2020-11-26 17:16:03 -0800 | [diff] [blame^] | 2269 | "fileDetails": [ # Identification of a File source used in the Dataflow job. |
| 2270 | { # Metadata for a File connector used by the job. |
| 2271 | "filePattern": "A String", # File Pattern used to access files by the connector. |
| 2272 | }, |
| 2273 | ], |
| 2274 | "spannerDetails": [ # Identification of a Spanner source used in the Dataflow job. |
| 2275 | { # Metadata for a Spanner connector used by the job. |
| 2276 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 2277 | "databaseId": "A String", # DatabaseId accessed in the connection. |
| 2278 | "projectId": "A String", # ProjectId accessed in the connection. |
| 2279 | }, |
| 2280 | ], |
| 2281 | "pubsubDetails": [ # Identification of a PubSub source used in the Dataflow job. |
| 2282 | { # Metadata for a PubSub connector used by the job. |
| 2283 | "topic": "A String", # Topic accessed in the connection. |
| 2284 | "subscription": "A String", # Subscription used in the connection. |
| 2285 | }, |
| 2286 | ], |
| 2287 | "bigTableDetails": [ # Identification of a BigTable source used in the Dataflow job. |
| 2288 | { # Metadata for a BigTable connector used by the job. |
| 2289 | "tableId": "A String", # TableId accessed in the connection. |
| 2290 | "instanceId": "A String", # InstanceId accessed in the connection. |
| 2291 | "projectId": "A String", # ProjectId accessed in the connection. |
| 2292 | }, |
| 2293 | ], |
| 2294 | }, |
| 2295 | "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. |
| 2296 | "type": "A String", # The type of Cloud Dataflow job. |
| 2297 | "stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. |
| 2298 | { # A message describing the state of a particular execution stage. |
| 2299 | "executionStageState": "A String", # Executions stage states allow the same set of values as JobState. |
| 2300 | "executionStageName": "A String", # The name of the execution stage. |
| 2301 | "currentStateTime": "A String", # The time at which the stage transitioned to this state. |
| 2302 | }, |
| 2303 | ], |
| 2304 | "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])?` |
| 2305 | "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. |
| 2306 | "createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot. |
| 2307 | "createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service. |
| 2308 | "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. |
| 2309 | "a_key": "A String", |
| 2310 | }, |
| 2311 | "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. |
| 2312 | "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. |
| 2313 | "requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state. |
| 2314 | "pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL. |
| 2315 | "executionPipelineStage": [ # Description of each stage of execution of the pipeline. |
| 2316 | { # Description of the composing transforms, names/ids, and input/outputs of a stage of execution. Some composing transforms and sources may have been generated by the Dataflow service during execution planning. |
| 2317 | "kind": "A String", # Type of tranform this stage is executing. |
| 2318 | "id": "A String", # Dataflow service generated id for this stage. |
| 2319 | "componentTransform": [ # Transforms that comprise this execution stage. |
| 2320 | { # Description of a transform executed as part of an execution stage. |
| 2321 | "originalTransform": "A String", # User name for the original user transform with which this transform is most closely associated. |
| 2322 | "name": "A String", # Dataflow service generated name for this source. |
| 2323 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 2324 | }, |
| 2325 | ], |
| 2326 | "prerequisiteStage": [ # Other stages that must complete before this stage can run. |
| 2327 | "A String", |
| 2328 | ], |
| 2329 | "outputSource": [ # Output sources for this stage. |
| 2330 | { # Description of an input or output of an execution stage. |
| 2331 | "name": "A String", # Dataflow service generated name for this source. |
| 2332 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 2333 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 2334 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2335 | }, |
| 2336 | ], |
| 2337 | "inputSource": [ # Input sources for this stage. |
| 2338 | { # Description of an input or output of an execution stage. |
| 2339 | "name": "A String", # Dataflow service generated name for this source. |
| 2340 | "sizeBytes": "A String", # Size of the source, if measurable. |
| 2341 | "userName": "A String", # Human-readable name for this source; may be user or system generated. |
| 2342 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2343 | }, |
| 2344 | ], |
| 2345 | "componentSource": [ # Collections produced and consumed by component transforms of this stage. |
| 2346 | { # Description of an interstitial value between transforms in an execution stage. |
| 2347 | "userName": "A String", # Human-readable name for this transform; may be user or system generated. |
| 2348 | "originalTransformOrCollection": "A String", # User name for the original user transform or collection with which this source is most closely associated. |
| 2349 | "name": "A String", # Dataflow service generated name for this source. |
| 2350 | }, |
| 2351 | ], |
| 2352 | "name": "A String", # Dataflow service generated name for this stage. |
| 2353 | }, |
| 2354 | ], |
| 2355 | "originalPipelineTransform": [ # Description of each transform in the pipeline and collections between them. |
| 2356 | { # Description of the type, names/ids, and input/outputs for a transform. |
| 2357 | "inputCollectionName": [ # User names for all collection inputs to this transform. |
| 2358 | "A String", |
| 2359 | ], |
| 2360 | "id": "A String", # SDK generated id of this transform instance. |
| 2361 | "name": "A String", # User provided name for this transform instance. |
| 2362 | "outputCollectionName": [ # User names for all collection outputs to this transform. |
| 2363 | "A String", |
| 2364 | ], |
| 2365 | "kind": "A String", # Type of transform. |
| 2366 | "displayData": [ # Transform-specific display data. |
| 2367 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 2368 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 2369 | "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. |
| 2370 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 2371 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 2372 | "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. |
| 2373 | "url": "A String", # An optional full URL. |
| 2374 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 2375 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 2376 | "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. |
| 2377 | "strValue": "A String", # Contains value if the data is of string type. |
| 2378 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 2379 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 2380 | }, |
| 2381 | ], |
| 2382 | }, |
| 2383 | ], |
| 2384 | "displayData": [ # Pipeline level display data. |
| 2385 | { # Data provided with a pipeline or transform to provide descriptive info. |
| 2386 | "int64Value": "A String", # Contains value if the data is of int64 type. |
| 2387 | "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. |
| 2388 | "label": "A String", # An optional label to display in a dax UI for the element. |
| 2389 | "floatValue": 3.14, # Contains value if the data is of float type. |
| 2390 | "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. |
| 2391 | "url": "A String", # An optional full URL. |
| 2392 | "boolValue": True or False, # Contains value if the data is of a boolean type. |
| 2393 | "javaClassValue": "A String", # Contains value if the data is of java class type. |
| 2394 | "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. |
| 2395 | "strValue": "A String", # Contains value if the data is of string type. |
| 2396 | "durationValue": "A String", # Contains value if the data is of duration type. |
| 2397 | "timestampValue": "A String", # Contains value if the data is of timestamp type. |
| 2398 | }, |
| 2399 | ], |
| 2400 | }, |
| 2401 | "transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. |
| 2402 | "a_key": "A String", |
| 2403 | }, |
| 2404 | "stepsLocation": "A String", # The GCS location where the steps are stored. |
| 2405 | }</pre> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 2406 | </div> |
| 2407 | |
| 2408 | </body></html> |