Package org.apache.beam.sdk.extensions.gcp.options

Interface GoogleApiDebugOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

BigQueryOptions, CloudResourceManagerOptions, DataflowPipelineOptions, DataflowPipelineWorkerPoolOptions, DataflowWorkerHarnessOptions, GcpOptions, GcsOptions, PubsubOptions, TestBigQueryOptions, TestDataflowPipelineOptions, TestPubsubOptions

public interface GoogleApiDebugOptions
extends PipelineOptions

These options configure debug settings for Google API clients created within the Apache Beam SDK.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GoogleApiDebugOptions.GoogleApiTracer	A GoogleClientRequestInitializer that adds the trace destination to Google API calls.

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method	Description
GoogleApiDebugOptions.GoogleApiTracer	getGoogleApiTrace()	This option enables tracing of API calls to Google services used within the Apache Beam SDK.
void	setGoogleApiTrace(GoogleApiDebugOptions.GoogleApiTracer commands)

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Details

getGoogleApiTrace

GoogleApiDebugOptions.GoogleApiTracer getGoogleApiTrace()

This option enables tracing of API calls to Google services used within the Apache Beam SDK. Values are expected in JSON format {"ApiName":"TraceDestination",...} where the ApiName represents the request classes canonical name. The TraceDestination is a logical trace consumer to whom the trace will be reported. Typically, "producer" is the right destination to use: this makes API traces available to the team offering the API. Note that by enabling this option, the contents of the requests to and from Google Cloud services will be made available to Google. For example, by specifying {"Dataflow":"producer"}, all calls to the Dataflow service will be made available to Google, specifically to the Google Cloud Dataflow team.

setGoogleApiTrace

void setGoogleApiTrace(GoogleApiDebugOptions.GoogleApiTracer commands)