Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dataflow_v1b3.projects.locations.html
blob: 925492ec40d1fbe8dd49be00c0fb246afa2b889c [file] [log] [blame]
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, 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
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, 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 Kim715bd7f2019-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.locations.html">locations</a></h1>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="dataflow_v1b3.projects.locations.flexTemplates.html">flexTemplates()</a></code>
79</p>
80<p class="firstline">Returns the flexTemplates Resource.</p>
81
82<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]83 <code><a href="dataflow_v1b3.projects.locations.jobs.html">jobs()</a></code>
84</p>
85<p class="firstline">Returns the jobs Resource.</p>
86
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]87<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]88 <code><a href="dataflow_v1b3.projects.locations.snapshots.html">snapshots()</a></code>
89</p>
90<p class="firstline">Returns the snapshots Resource.</p>
91
92<p class="toc_element">
93 <code><a href="dataflow_v1b3.projects.locations.sql.html">sql()</a></code>
94</p>
95<p class="firstline">Returns the sql Resource.</p>
96
97<p class="toc_element">
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]98 <code><a href="dataflow_v1b3.projects.locations.templates.html">templates()</a></code>
99</p>
100<p class="firstline">Returns the templates Resource.</p>
101
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code><a href="#workerMessages">workerMessages(projectId, location, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]104<p class="firstline">Send a worker_message to the service.</p>
105<h3>Method Details</h3>
106<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]107 <code class="details" id="workerMessages">workerMessages(projectId, location, body=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]108 <pre>Send a worker_message to the service.
109
110Args:
111 projectId: string, The project to send the WorkerMessages to. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 location: string, The [regional endpoint]
113(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
114contains the job. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]115 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]116 The object takes the form of:
117
118{ # A request for sending worker messages to the service.
119 "workerMessages": [ # The WorkerMessages to send.
120 { # WorkerMessage provides information to the backend about a worker.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121 "workerShutdownNotice": { # Shutdown notification from workers. This is to be sent by the shutdown # Shutdown notice by workers.
122 # script of the worker VM so that the backend knows that the VM is being
123 # shut down.
124 "reason": "A String", # The reason for the worker shutdown.
125 # Current possible values are:
126 # "UNKNOWN": shutdown reason is unknown.
127 # "PREEMPTION": shutdown reason is preemption.
128 # Other possible reasons may be added in the future.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]129 },
130 "workerMetrics": { # Worker metrics exported from workers. This contains resource utilization # Resource metrics reported by workers.
131 # metrics accumulated from a variety of sources. For more information, see
132 # go/df-resource-signals.
133 "cpuTime": [ # CPU utilization samples.
134 { # Modeled after information exposed by /proc/stat.
135 "totalMs": "A String", # Total active CPU time across all cores (ie., non-idle) in milliseconds
136 # since start-up.
137 "rate": 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous
138 # sample.
139 "timestamp": "A String", # Timestamp of the measurement.
140 },
141 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]142 "containers": { # Per container information.
143 # Key: container name.
144 "a_key": # Object with schema name: ResourceUtilizationReport
145 },
146 "memoryInfo": [ # Memory utilization samples.
147 { # Information about the memory usage of a worker or a container within a
148 # worker.
149 "totalGbMs": "A String", # Total memory (RSS) usage since start up in GB * ms.
150 "currentLimitBytes": "A String", # Instantenous memory limit in bytes.
151 "currentRssBytes": "A String", # Instantenous memory (RSS) size in bytes.
152 "timestamp": "A String", # Timestamp of the measurement.
153 },
154 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]155 },
156 "workerMessageCode": { # A message code is used to report status and error messages to the service. # A worker message code.
157 # The message codes are intended to be machine readable. The service will
158 # take care of translating these into user understandable messages if
159 # necessary.
160 #
161 # Example use cases:
162 # 1. Worker processes reporting successful startup.
163 # 2. Worker processes reporting specific errors (e.g. package staging
164 # failure).
165 "code": "A String", # The code is a string intended for consumption by a machine that identifies
166 # the type of message being sent.
167 # Examples:
168 # 1. "HARNESS_STARTED" might be used to indicate the worker harness has
169 # started.
170 # 2. "GCS_DOWNLOAD_ERROR" might be used to indicate an error downloading
171 # a GCS file as part of the boot process of one of the worker containers.
172 #
173 # This is a string and not an enum to make it easy to add new codes without
174 # waiting for an API change.
175 "parameters": { # Parameters contains specific information about the code.
176 #
177 # This is a struct to allow parameters of different types.
178 #
179 # Examples:
180 # 1. For a "HARNESS_STARTED" message parameters might provide the name
181 # of the worker and additional data like timing information.
182 # 2. For a "GCS_DOWNLOAD_ERROR" parameters might contain fields listing
183 # the GCS objects being downloaded and fields containing errors.
184 #
185 # In general complex data structures should be avoided. If a worker
186 # needs to send a specific and complicated data structure then please
187 # consider defining a new proto and adding it to the data oneof in
188 # WorkerMessageResponse.
189 #
190 # Conventions:
191 # Parameters should only be used for information that isn't typically passed
192 # as a label.
193 # hostname and other worker identifiers should almost always be passed
194 # as labels since they will be included on most messages.
195 "a_key": "", # Properties of the object.
196 },
197 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]198 "labels": { # Labels are used to group WorkerMessages.
199 # For example, a worker_message about a particular container
200 # might have the labels:
201 # { "JOB_ID": "2015-04-22",
202 # "WORKER_ID": "wordcount-vm-2015…"
203 # "CONTAINER_TYPE": "worker",
204 # "CONTAINER_ID": "ac1234def"}
205 # Label tags typically correspond to Label enum values. However, for ease
206 # of development other strings can be used as tags. LABEL_UNSPECIFIED should
207 # not be used here.
208 "a_key": "A String",
209 },
210 "workerLifecycleEvent": { # A report of an event in a worker's lifecycle. # Record of worker lifecycle events.
211 # The proto contains one event, because the worker is expected to
212 # asynchronously send each message immediately after the event.
213 # Due to this asynchrony, messages may arrive out of order (or missing), and it
214 # is up to the consumer to interpret.
215 # The timestamp of the event is in the enclosing WorkerMessage proto.
216 "event": "A String", # The event being reported.
217 "containerStartTime": "A String", # The start time of this container. All events will report this so that
218 # events can be grouped together across container/VM restarts.
219 "metadata": { # Other stats that can accompany an event. E.g.
220 # { "downloaded_bytes" : "123456" }
221 "a_key": "A String",
222 },
223 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]224 "time": "A String", # The timestamp of the worker_message.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]225 "workerHealthReport": { # WorkerHealthReport contains information about the health of a worker. # The health of a worker.
226 #
227 # The VM should be identified by the labels attached to the WorkerMessage that
228 # this health ping belongs to.
229 "vmIsBroken": True or False, # Whether the VM is in a permanently broken state.
230 # Broken VMs should be abandoned or deleted ASAP to avoid assigning or
231 # completing any work.
232 "vmStartupTime": "A String", # The time the VM was booted.
233 "vmIsHealthy": True or False, # Whether the VM is currently healthy.
234 "msg": "A String", # A message describing any unusual health reports.
235 "reportInterval": "A String", # The interval at which the worker is sending health reports.
236 # The default value of 0 should be interpreted as the field is not being
237 # explicitly set by the worker.
238 "pods": [ # The pods running on the worker. See:
239 # http://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod
240 #
241 # This field is used by the worker to send the status of the indvidual
242 # containers running on each worker.
243 {
244 "a_key": "", # Properties of the object.
245 },
246 ],
247 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]248 },
249 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250 "location": "A String", # The [regional endpoint]
251 # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
252 # contains the job.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]253 }
254
255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 { # The response to the worker messages.
264 "workerMessageResponses": [ # The servers response to the worker messages.
265 { # A worker_message response allows the server to pass information to the
266 # sender.
267 "workerHealthReportResponse": { # WorkerHealthReportResponse contains information returned to the worker # The service's response to a worker's health report.
268 # in response to a health ping.
269 "reportInterval": "A String", # A positive value indicates the worker should change its reporting interval
270 # to the specified value.
271 #
272 # The default value of zero means no change in report rate is requested by
273 # the server.
274 },
275 "workerMetricsResponse": { # Service-side response to WorkerMessage reporting resource utilization. # Service's response to reporting worker metrics (currently empty).
276 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "workerShutdownNoticeResponse": { # Service-side response to WorkerMessage issuing shutdown notice. # Service's response to shutdown notice (currently empty).
278 },
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]279 },
280 ],
281 }</pre>
282</div>
283
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]284</body></html>