| 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></h1> |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="dataflow_v1b3.projects.jobs.html">jobs()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the jobs Resource.</p> |
| 81 | |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 82 | <p class="toc_element"> |
| Jon Wayne Parrott | 692617a | 2017-01-06 09:58:29 -0800 | [diff] [blame] | 83 | <code><a href="dataflow_v1b3.projects.locations.html">locations()</a></code> |
| 84 | </p> |
| 85 | <p class="firstline">Returns the locations Resource.</p> |
| 86 | |
| 87 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 88 | <code><a href="dataflow_v1b3.projects.snapshots.html">snapshots()</a></code> |
| 89 | </p> |
| 90 | <p class="firstline">Returns the snapshots Resource.</p> |
| 91 | |
| 92 | <p class="toc_element"> |
| Jon Wayne Parrott | 7d5badb | 2016-08-16 12:44:29 -0700 | [diff] [blame] | 93 | <code><a href="dataflow_v1b3.projects.templates.html">templates()</a></code> |
| 94 | </p> |
| 95 | <p class="firstline">Returns the templates Resource.</p> |
| 96 | |
| 97 | <p class="toc_element"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 98 | <code><a href="#close">close()</a></code></p> |
| 99 | <p class="firstline">Close httplib2 connections.</p> |
| 100 | <p class="toc_element"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 101 | <code><a href="#deleteSnapshots">deleteSnapshots(projectId, location=None, snapshotId=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | <p class="firstline">Deletes a snapshot.</p> |
| 103 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | <code><a href="#workerMessages">workerMessages(projectId, body=None, x__xgafv=None)</a></code></p> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 105 | <p class="firstline">Send a worker_message to the service.</p> |
| 106 | <h3>Method Details</h3> |
| 107 | <div class="method"> |
| Dmitry Frenkel | 3e17f89 | 2020-10-06 16:46:05 -0700 | [diff] [blame] | 108 | <code class="details" id="close">close()</code> |
| 109 | <pre>Close httplib2 connections.</pre> |
| 110 | </div> |
| 111 | |
| 112 | <div class="method"> |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 113 | <code class="details" id="deleteSnapshots">deleteSnapshots(projectId, location=None, snapshotId=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 114 | <pre>Deletes a snapshot. |
| 115 | |
| 116 | Args: |
| 117 | projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required) |
| Yoshi Automation Bot | 0d561ef | 2020-11-25 07:50:41 -0800 | [diff] [blame] | 118 | location: string, The location that contains this snapshot. |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 119 | snapshotId: string, The ID of the snapshot. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 120 | x__xgafv: string, V1 error format. |
| 121 | Allowed values |
| 122 | 1 - v1 error format |
| 123 | 2 - v2 error format |
| 124 | |
| 125 | Returns: |
| 126 | An object of the form: |
| 127 | |
| 128 | { # Response from deleting a snapshot. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 129 | }</pre> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 130 | </div> |
| 131 | |
| 132 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 133 | <code class="details" id="workerMessages">workerMessages(projectId, body=None, x__xgafv=None)</code> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 134 | <pre>Send a worker_message to the service. |
| 135 | |
| 136 | Args: |
| 137 | projectId: string, The project to send the WorkerMessages to. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 138 | body: object, The request body. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 139 | The object takes the form of: |
| 140 | |
| 141 | { # A request for sending worker messages to the service. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 142 | "location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job. |
| 143 | "workerMessages": [ # The WorkerMessages to send. |
| 144 | { # WorkerMessage provides information to the backend about a worker. |
| 145 | "labels": { # Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { "JOB_ID": "2015-04-22", "WORKER_ID": "wordcount-vm-2015…" "CONTAINER_TYPE": "worker", "CONTAINER_ID": "ac1234def"} Label tags typically correspond to Label enum values. However, for ease of development other strings can be used as tags. LABEL_UNSPECIFIED should not be used here. |
| 146 | "a_key": "A String", |
| 147 | }, |
| 148 | "time": "A String", # The timestamp of the worker_message. |
| 149 | "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 150 | "msg": "A String", # Message describing any unusual health reports. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 151 | "pods": [ # The pods running on the worker. See: http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod This field is used by the worker to send the status of the indvidual containers running on each worker. |
| 152 | { |
| Yoshi Automation Bot | 0bf565c | 2020-12-09 08:56:03 -0800 | [diff] [blame] | 153 | "a_key": "", # Properties of the object. |
| 154 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 155 | ], |
| 156 | "reportInterval": "A String", # The interval at which the worker is sending health reports. The default value of 0 should be interpreted as the field is not being explicitly set by the worker. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 157 | "vmBrokenCode": "A String", # Code to describe a specific reason, if known, that a VM has reported broken state. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 158 | "vmIsBroken": True or False, # Whether the VM is in a permanently broken state. Broken VMs should be abandoned or deleted ASAP to avoid assigning or completing any work. |
| 159 | "vmIsHealthy": True or False, # Whether the VM is currently healthy. |
| 160 | "vmStartupTime": "A String", # The time the VM was booted. |
| 161 | }, |
| 162 | "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. The proto contains one event, because the worker is expected to asynchronously send each message immediately after the event. Due to this asynchrony, messages may arrive out of order (or missing), and it is up to the consumer to interpret. The timestamp of the event is in the enclosing WorkerMessage proto. # Record of worker lifecycle events. |
| 163 | "containerStartTime": "A String", # The start time of this container. All events will report this so that events can be grouped together across container/VM restarts. |
| 164 | "event": "A String", # The event being reported. |
| 165 | "metadata": { # Other stats that can accompany an event. E.g. { "downloaded_bytes" : "123456" } |
| 166 | "a_key": "A String", |
| Bu Sun Kim | 673ec5c | 2020-11-16 11:05:03 -0700 | [diff] [blame] | 167 | }, |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 168 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 169 | "workerMessageCode": { # A message code is used to report status and error messages to the service. The message codes are intended to be machine readable. The service will take care of translating these into user understandable messages if necessary. Example use cases: 1. Worker processes reporting successful startup. 2. Worker processes reporting specific errors (e.g. package staging failure). # A worker message code. |
| Anthonios Partheniou | 10f4b67 | 2021-04-13 14:47:53 -0400 | [diff] [blame] | 170 | "code": "A String", # The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. "HARNESS_STARTED" might be used to indicate the worker harness has started. 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading a Cloud Storage file as part of the boot process of one of the worker containers. This is a string and not an enum to make it easy to add new codes without waiting for an API change. |
| 171 | "parameters": { # Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a "HARNESS_STARTED" message parameters might provide the name of the worker and additional data like timing information. 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing the Cloud Storage objects being downloaded and fields containing errors. In general complex data structures should be avoided. If a worker needs to send a specific and complicated data structure then please consider defining a new proto and adding it to the data oneof in WorkerMessageResponse. Conventions: Parameters should only be used for information that isn't typically passed as a label. hostname and other worker identifiers should almost always be passed as labels since they will be included on most messages. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 172 | "a_key": "", # Properties of the object. |
| 173 | }, |
| 174 | }, |
| 175 | "workerMetrics": { # Worker metrics exported from workers. This contains resource utilization metrics accumulated from a variety of sources. For more information, see go/df-resource-signals. # Resource metrics reported by workers. |
| 176 | "containers": { # Per container information. Key: container name. |
| 177 | "a_key": # Object with schema name: ResourceUtilizationReport |
| 178 | }, |
| 179 | "cpuTime": [ # CPU utilization samples. |
| 180 | { # Modeled after information exposed by /proc/stat. |
| 181 | "rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous sample. |
| 182 | "timestamp": "A String", # Timestamp of the measurement. |
| 183 | "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds since start-up. |
| 184 | }, |
| 185 | ], |
| 186 | "memoryInfo": [ # Memory utilization samples. |
| 187 | { # Information about the memory usage of a worker or a container within a worker. |
| 188 | "currentLimitBytes": "A String", # Instantenous memory limit in bytes. |
| 189 | "currentRssBytes": "A String", # Instantenous memory (RSS) size in bytes. |
| 190 | "timestamp": "A String", # Timestamp of the measurement. |
| 191 | "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms. |
| 192 | }, |
| 193 | ], |
| 194 | }, |
| 195 | "workerShutdownNotice": { # Shutdown notification from workers. This is to be sent by the shutdown script of the worker VM so that the backend knows that the VM is being shut down. # Shutdown notice by workers. |
| 196 | "reason": "A String", # The reason for the worker shutdown. Current possible values are: "UNKNOWN": shutdown reason is unknown. "PREEMPTION": shutdown reason is preemption. Other possible reasons may be added in the future. |
| 197 | }, |
| 198 | }, |
| 199 | ], |
| 200 | } |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 201 | |
| 202 | x__xgafv: string, V1 error format. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 203 | Allowed values |
| 204 | 1 - v1 error format |
| 205 | 2 - v2 error format |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 206 | |
| 207 | Returns: |
| 208 | An object of the form: |
| 209 | |
| 210 | { # The response to the worker messages. |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 211 | "workerMessageResponses": [ # The servers response to the worker messages. |
| 212 | { # A worker_message response allows the server to pass information to the sender. |
| 213 | "workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker in response to a health ping. # The service's response to a worker's health report. |
| 214 | "reportInterval": "A String", # A positive value indicates the worker should change its reporting interval to the specified value. The default value of zero means no change in report rate is requested by the server. |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 215 | }, |
| Yoshi Automation Bot | cc94ec8 | 2021-01-15 07:10:04 -0800 | [diff] [blame] | 216 | "workerMetricsResponse": { # Service-side response to WorkerMessage reporting resource utilization. # Service's response to reporting worker metrics (currently empty). |
| 217 | }, |
| 218 | "workerShutdownNoticeResponse": { # Service-side response to WorkerMessage issuing shutdown notice. # Service's response to shutdown notice (currently empty). |
| 219 | }, |
| 220 | }, |
| 221 | ], |
| 222 | }</pre> |
| Jon Wayne Parrott | 36e41bc | 2016-02-19 16:02:29 -0800 | [diff] [blame] | 223 | </div> |
| 224 | |
| Nathaniel Manista | 4f877e5 | 2015-06-15 16:44:50 +0000 | [diff] [blame] | 225 | </body></html> |