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