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