Dataflow API . projects . locations . jobs . debug

Instance Methods

close()

Close httplib2 connections.

getConfig(projectId, location, jobId, body=None, x__xgafv=None)

Get encoded debug configuration for component. Not cacheable.

getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)

Get worker stacktraces from debug capture.

sendCapture(projectId, location, jobId, body=None, x__xgafv=None)

Send encoded debug capture data for component.

Method Details

close()
Close httplib2 connections.
getConfig(projectId, location, jobId, body=None, x__xgafv=None)
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.
}
getWorkerStacktraces(projectId, location, jobId, body=None, x__xgafv=None)
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.
        },
      ],
    },
  ],
}
sendCapture(projectId, location, jobId, body=None, x__xgafv=None)
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
}