docs/dyn/dataflow_v1b3.projects.locations.jobs.debug.html - platform/external/python/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <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>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#close">close()</a></code></p>
 <p class="firstline">Close httplib2 connections.</p>
 <p class="toc_element">
   <code><a href="#getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Get encoded debug configuration for component. Not cacheable.</p>
 <p class="toc_element">
   <code><a href="#getWorkerStacktraces">getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Get worker stacktraces from debug capture.</p>
 <p class="toc_element">
   <code><a href="#sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Send encoded debug capture data for component.</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="close">close()</code>
   <pre>Close httplib2 connections.</pre>
 </div>

 <div class="method">
     <code class="details" id="getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</code>
   <pre>Get encoded debug configuration for component. Not cacheable.

 Args:
   projectId: string, The project id. (required)
   location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
   jobId: string, The job id. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request to get updated debug configuration for component.
   &quot;componentId&quot;: &quot;A String&quot;, # The internal component id for which debug configuration is requested.
   &quot;location&quot;: &quot;A String&quot;, # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
   &quot;workerId&quot;: &quot;A String&quot;, # The worker id, i.e., VM hostname.
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response to a get debug configuration request.
   &quot;config&quot;: &quot;A String&quot;, # The encoded debug configuration for the requested component.
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="getWorkerStacktraces">getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)</code>
   <pre>Get worker stacktraces from debug capture.

 Args:
   projectId: string, The project id. (required)
   location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
   jobId: string, The job for which to get stacktraces. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request to get worker stacktraces from debug capture.
   &quot;workerId&quot;: &quot;A String&quot;, # The worker for which to get stacktraces. The returned stacktraces will be for the SDK harness running on this worker.
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response to get worker stacktraces from debug capture.
   &quot;sdks&quot;: [ # Repeated as unified worker may have multiple SDK processes.
     { # A structured representation of an SDK.
       &quot;sdkId&quot;: &quot;A String&quot;, # The SDK harness id.
       &quot;stacks&quot;: [ # The stacktraces for the processes running on the SDK harness.
         { # A structuredstacktrace for a process running on the worker.
           &quot;stackContent&quot;: &quot;A String&quot;, # The raw stack trace.
           &quot;threadCount&quot;: 42, # With java thread dumps we may get collapsed stacks e.g., N threads in stack &quot;&quot;. Instead of having to copy over the same stack trace N times, this int field captures this.
           &quot;threadName&quot;: &quot;A String&quot;, # Thread name. For example, &quot;CommitThread-0,10,main&quot;
           &quot;threadState&quot;: &quot;A String&quot;, # The state of the thread. For example, &quot;WAITING&quot;.
           &quot;timestamp&quot;: &quot;A String&quot;, # Timestamp at which the stack was captured.
         },
       ],
     },
   ],
 }</pre>
 </div>

 <div class="method">
     <code class="details" id="sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</code>
   <pre>Send encoded debug capture data for component.

 Args:
   projectId: string, The project id. (required)
   location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
   jobId: string, The job id. (required)
   body: object, The request body.
     The object takes the form of:

 { # Request to send encoded debug information. Next ID: 8
   &quot;componentId&quot;: &quot;A String&quot;, # The internal component id for which debug information is sent.
   &quot;data&quot;: &quot;A String&quot;, # The encoded debug information.
   &quot;dataFormat&quot;: &quot;A String&quot;, # Format for the data field above (id=5).
   &quot;location&quot;: &quot;A String&quot;, # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
   &quot;workerId&quot;: &quot;A String&quot;, # The worker id, i.e., VM hostname.
 }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # Response to a send capture request. nothing
 }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<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>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#close">close()</a></code></p>
	<p class="firstline">Close httplib2 connections.</p>
	<p class="toc_element">
	<code><a href="#getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Get encoded debug configuration for component. Not cacheable.</p>
	<p class="toc_element">
	<code><a href="#getWorkerStacktraces">getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Get worker stacktraces from debug capture.</p>
	<p class="toc_element">
	<code><a href="#sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Send encoded debug capture data for component.</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="close">close()</code>
	<pre>Close httplib2 connections.</pre>
	</div>

	<div class="method">
	<code class="details" id="getConfig">getConfig(projectId, location, jobId, body=None, x__xgafv=None)</code>
	<pre>Get encoded debug configuration for component. Not cacheable.

	Args:
	projectId: string, The project id. (required)
	location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
	jobId: string, The job id. (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request to get updated debug configuration for component.
	"componentId": "A String", # The internal component id for which debug configuration is requested.
	"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
	"workerId": "A String", # The worker id, i.e., VM hostname.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response to a get debug configuration request.
	"config": "A String", # The encoded debug configuration for the requested component.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="getWorkerStacktraces">getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)</code>
	<pre>Get worker stacktraces from debug capture.

	Args:
	projectId: string, The project id. (required)
	location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
	jobId: string, The job for which to get stacktraces. (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request to get worker stacktraces from debug capture.
	"workerId": "A String", # The worker for which to get stacktraces. The returned stacktraces will be for the SDK harness running on this worker.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response to get worker stacktraces from debug capture.
	"sdks": [ # Repeated as unified worker may have multiple SDK processes.
	{ # A structured representation of an SDK.
	"sdkId": "A String", # The SDK harness id.
	"stacks": [ # The stacktraces for the processes running on the SDK harness.
	{ # A structuredstacktrace for a process running on the worker.
	"stackContent": "A String", # The raw stack trace.
	"threadCount": 42, # With java thread dumps we may get collapsed stacks e.g., N threads in stack "". Instead of having to copy over the same stack trace N times, this int field captures this.
	"threadName": "A String", # Thread name. For example, "CommitThread-0,10,main"
	"threadState": "A String", # The state of the thread. For example, "WAITING".
	"timestamp": "A String", # Timestamp at which the stack was captured.
	},
	],
	},
	],
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="sendCapture">sendCapture(projectId, location, jobId, body=None, x__xgafv=None)</code>
	<pre>Send encoded debug capture data for component.

	Args:
	projectId: string, The project id. (required)
	location: string, The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id. (required)
	jobId: string, The job id. (required)
	body: object, The request body.
	The object takes the form of:

	{ # Request to send encoded debug information. Next ID: 8
	"componentId": "A String", # The internal component id for which debug information is sent.
	"data": "A String", # The encoded debug information.
	"dataFormat": "A String", # Format for the data field above (id=5).
	"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains the job specified by job_id.
	"workerId": "A String", # The worker id, i.e., VM hostname.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # Response to a send capture request. nothing
	}</pre>
	</div>

	</body></html>