Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c482712935d1c1331e33bd7f9968bd3b2be223bb / . / docs / dyn / dataflow_v1b3.projects.locations.jobs.debug.html
blob: 6e6689c1c62ac20c2cf26848b2e6ffb5e181f145 [file] [log] [blame]
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[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> . <a href="dataflow_v1b3.projects.locations.jobs.html">jobs</a> . <a href="dataflow_v1b3.projects.locations.jobs.debug.html">debug</a></h1>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[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="#getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]79<p class="firstline">Get encoded debug configuration for component. Not cacheable.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]82<p class="firstline">Send encoded debug capture data for component.</p>
83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85 <code class="details" id="getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]86 <pre>Get encoded debug configuration for component. Not cacheable.
87
88Args:
89 projectId: string, The project id. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 location: string, The [regional endpoint]
91(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
92contains the job specified by job_id. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]93 jobId: string, The job id. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]95 The object takes the form of:
96
97{ # Request to get updated debug configuration for component.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]98 &quot;componentId&quot;: &quot;A String&quot;, # The internal component id for which debug configuration is
99 # requested.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]100 &quot;workerId&quot;: &quot;A String&quot;, # The worker id, i.e., VM hostname.
101 &quot;location&quot;: &quot;A String&quot;, # The [regional endpoint]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
103 # contains the job specified by job_id.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]104 }
105
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111Returns:
112 An object of the form:
113
114 { # Response to a get debug configuration request.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]115 &quot;config&quot;: &quot;A String&quot;, # The encoded debug configuration for the requested component.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]116 }</pre>
117</div>
118
119<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]120 <code class="details" id="sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]121 <pre>Send encoded debug capture data for component.
122
123Args:
124 projectId: string, The project id. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]125 location: string, The [regional endpoint]
126(https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
127contains the job specified by job_id. (required)
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]128 jobId: string, The job id. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]129 body: object, The request body.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]130 The object takes the form of:
131
132{ # Request to send encoded debug information.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]133 &quot;componentId&quot;: &quot;A String&quot;, # The internal component id for which debug information is sent.
134 &quot;workerId&quot;: &quot;A String&quot;, # The worker id, i.e., VM hostname.
135 &quot;location&quot;: &quot;A String&quot;, # The [regional endpoint]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 # (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that
137 # contains the job specified by job_id.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;data&quot;: &quot;A String&quot;, # The encoded debug information.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]139 }
140
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 { # Response to a send capture request.
150 # nothing
151 }</pre>
152</div>
153
154</body></html>