Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / af918e8ef422438aaca0c468de8b3b2c184d884e / . / docs / dyn / dataflow_v1b3.projects.html
blob: bdf46c206093f6bba7709b126f5119198afabc41 [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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]78 <code><a href="dataflow_v1b3.projects.catalogTemplates.html">catalogTemplates()</a></code>
79</p>
80<p class="firstline">Returns the catalogTemplates Resource.</p>
81
82<p class="toc_element">
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83 <code><a href="dataflow_v1b3.projects.jobs.html">jobs()</a></code>
84</p>
85<p class="firstline">Returns the jobs Resource.</p>
86
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]87<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88 <code><a href="dataflow_v1b3.projects.locations.html">locations()</a></code>
89</p>
90<p class="firstline">Returns the locations Resource.</p>
91
92<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code><a href="dataflow_v1b3.projects.snapshots.html">snapshots()</a></code>
94</p>
95<p class="firstline">Returns the snapshots Resource.</p>
96
97<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]98 <code><a href="dataflow_v1b3.projects.templateVersions.html">templateVersions()</a></code>
99</p>
100<p class="firstline">Returns the templateVersions Resource.</p>
101
102<p class="toc_element">
Jon Wayne Parrott7d5badb2016-08-16 12:44:29 -0700[diff] [blame]103 <code><a href="dataflow_v1b3.projects.templates.html">templates()</a></code>
104</p>
105<p class="firstline">Returns the templates Resource.</p>
106
107<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]108 <code><a href="#close">close()</a></code></p>
109<p class="firstline">Close httplib2 connections.</p>
110<p class="toc_element">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]111 <code><a href="#deleteSnapshots">deleteSnapshots(projectId, snapshotId=None, location=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112<p class="firstline">Deletes a snapshot.</p>
113<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]114 <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]115<p class="firstline">Send a worker_message to the service.</p>
116<h3>Method Details</h3>
117<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 <code class="details" id="close">close()</code>
119 <pre>Close httplib2 connections.</pre>
120</div>
121
122<div class="method">
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]123 <code class="details" id="deleteSnapshots">deleteSnapshots(projectId, snapshotId=None, location=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]124 <pre>Deletes a snapshot.
125
126Args:
127 projectId: string, The ID of the Cloud Platform project that the snapshot belongs to. (required)
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]128 snapshotId: string, The ID of the snapshot.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]129 location: string, The location that contains this snapshot.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 x__xgafv: string, V1 error format.
131 Allowed values
132 1 - v1 error format
133 2 - v2 error format
134
135Returns:
136 An object of the form:
137
138 { # Response from deleting a snapshot.
139 }</pre>
140</div>
141
142<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]143 <code class="details" id="workerMessages">workerMessages(projectId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]144 <pre>Send a worker_message to the service.
145
146Args:
147 projectId: string, The project to send the WorkerMessages to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]148 body: object, The request body.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]149 The object takes the form of:
150
151{ # A request for sending worker messages to the service.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]152 &quot;location&quot;: &quot;A String&quot;, # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]153 &quot;workerMessages&quot;: [ # The WorkerMessages to send.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]154 { # WorkerMessage provides information to the backend about a worker.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]155 &quot;workerLifecycleEvent&quot;: { # A report of an event in a worker&#x27;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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]156 &quot;containerStartTime&quot;: &quot;A String&quot;, # The start time of this container. All events will report this so that events can be grouped together across container/VM restarts.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]157 &quot;metadata&quot;: { # Other stats that can accompany an event. E.g. { &quot;downloaded_bytes&quot; : &quot;123456&quot; }
158 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]159 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]160 &quot;event&quot;: &quot;A String&quot;, # The event being reported.
161 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]162 &quot;workerShutdownNotice&quot;: { # 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.
163 &quot;reason&quot;: &quot;A String&quot;, # The reason for the worker shutdown. Current possible values are: &quot;UNKNOWN&quot;: shutdown reason is unknown. &quot;PREEMPTION&quot;: shutdown reason is preemption. Other possible reasons may be added in the future.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]164 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]165 &quot;workerMessageCode&quot;: { # 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.
166 &quot;parameters&quot;: { # Parameters contains specific information about the code. This is a struct to allow parameters of different types. Examples: 1. For a &quot;HARNESS_STARTED&quot; message parameters might provide the name of the worker and additional data like timing information. 2. For a &quot;GCS_DOWNLOAD_ERROR&quot; parameters might contain fields listing the GCS 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&#x27;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.
167 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
168 },
169 &quot;code&quot;: &quot;A String&quot;, # The code is a string intended for consumption by a machine that identifies the type of message being sent. Examples: 1. &quot;HARNESS_STARTED&quot; might be used to indicate the worker harness has started. 2. &quot;GCS_DOWNLOAD_ERROR&quot; might be used to indicate an error downloading a GCS 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.
170 },
171 &quot;time&quot;: &quot;A String&quot;, # The timestamp of the worker_message.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]172 &quot;workerHealthReport&quot;: { # 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]173 &quot;vmStartupTime&quot;: &quot;A String&quot;, # The time the VM was booted.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]174 &quot;vmIsBroken&quot;: 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.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]175 &quot;vmIsHealthy&quot;: True or False, # Whether the VM is currently healthy.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]176 &quot;pods&quot;: [ # 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.
177 {
178 &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
179 },
180 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]181 &quot;reportInterval&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]182 &quot;msg&quot;: &quot;A String&quot;, # A message describing any unusual health reports.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]183 },
184 &quot;labels&quot;: { # Labels are used to group WorkerMessages. For example, a worker_message about a particular container might have the labels: { &quot;JOB_ID&quot;: &quot;2015-04-22&quot;, &quot;WORKER_ID&quot;: &quot;wordcount-vm-2015…&quot; &quot;CONTAINER_TYPE&quot;: &quot;worker&quot;, &quot;CONTAINER_ID&quot;: &quot;ac1234def&quot;} 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.
185 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]186 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]187 &quot;workerMetrics&quot;: { # 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.
188 &quot;memoryInfo&quot;: [ # Memory utilization samples.
189 { # Information about the memory usage of a worker or a container within a worker.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]190 &quot;totalGbMs&quot;: &quot;A String&quot;, # Total memory (RSS) usage since start up in GB * ms.
191 &quot;currentLimitBytes&quot;: &quot;A String&quot;, # Instantenous memory limit in bytes.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]192 &quot;currentRssBytes&quot;: &quot;A String&quot;, # Instantenous memory (RSS) size in bytes.
193 &quot;timestamp&quot;: &quot;A String&quot;, # Timestamp of the measurement.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]194 },
195 ],
196 &quot;containers&quot;: { # Per container information. Key: container name.
197 &quot;a_key&quot;: # Object with schema name: ResourceUtilizationReport
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]198 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]199 &quot;cpuTime&quot;: [ # CPU utilization samples.
200 { # Modeled after information exposed by /proc/stat.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]201 &quot;totalMs&quot;: &quot;A String&quot;, # Total active CPU time across all cores (ie., non-idle) in milliseconds since start-up.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]202 &quot;timestamp&quot;: &quot;A String&quot;, # Timestamp of the measurement.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]203 &quot;rate&quot;: 3.14, # Average CPU utilization rate (% non-idle cpu / second) since previous sample.
204 },
205 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]206 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]207 },
208 ],
209 }
210
211 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]212 Allowed values
213 1 - v1 error format
214 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215
216Returns:
217 An object of the form:
218
219 { # The response to the worker messages.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 &quot;workerMessageResponses&quot;: [ # The servers response to the worker messages.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]221 { # A worker_message response allows the server to pass information to the sender.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]222 &quot;workerShutdownNoticeResponse&quot;: { # Service-side response to WorkerMessage issuing shutdown notice. # Service&#x27;s response to shutdown notice (currently empty).
223 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]224 &quot;workerMetricsResponse&quot;: { # Service-side response to WorkerMessage reporting resource utilization. # Service&#x27;s response to reporting worker metrics (currently empty).
225 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]226 &quot;workerHealthReportResponse&quot;: { # WorkerHealthReportResponse contains information returned to the worker in response to a health ping. # The service&#x27;s response to a worker&#x27;s health report.
227 &quot;reportInterval&quot;: &quot;A String&quot;, # 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.
228 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]229 },
230 ],
231 }</pre>
232</div>
233
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]234</body></html>