org.apache.beam.sdk.io.gcp.pubsub

Interface PubsubOptions

All Superinterfaces:

ApplicationNameOptions, GcpOptions, GoogleApiDebugOptions, HasDisplayData, PipelineOptions, StreamingOptions

All Known Subinterfaces:

DataflowPipelineOptions, DataflowWorkerHarnessOptions, TestDataflowPipelineOptions, TestPubsubOptions

public interface PubsubOptions
extends ApplicationNameOptions, GcpOptions, PipelineOptions, StreamingOptions

Properties that can be set when using Google Cloud Pub/Sub with the Apache Beam SDK.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.extensions.gcp.options.GcpOptions

GcpOptions.DefaultProjectFactory, GcpOptions.EnableStreamingEngineFactory, GcpOptions.GcpOAuthScopesFactory, GcpOptions.GcpTempLocationFactory, GcpOptions.GcpUserCredentialsFactory

Nested classes/interfaces inherited from interface org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions

GoogleApiDebugOptions.GoogleApiTracer

Field Summary

Fields inherited from interface org.apache.beam.sdk.extensions.gcp.options.GcpOptions

STREAMING_ENGINE_EXPERIMENT, WINDMILL_SERVICE_EXPERIMENT

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPubsubRootUrl() Root URL for use with the Google Cloud Pub/Sub API.
void	setPubsubRootUrl(java.lang.String value)
static java.lang.String	targetForRootUrl(java.lang.String urlString) Internal only utility for converting getPubsubRootUrl() (e.g.

Methods inherited from interface org.apache.beam.sdk.extensions.gcp.options.GcpOptions

getCredentialFactoryClass, getDataflowKmsKey, getGcpCredential, getGcpOauthScopes, getGcpTempLocation, getImpersonateServiceAccount, getProject, getWorkerRegion, getWorkerZone, getZone, isEnableStreamingEngine, setCredentialFactoryClass, setDataflowKmsKey, setEnableStreamingEngine, setGcpCredential, setGcpOauthScopes, setGcpTempLocation, setImpersonateServiceAccount, setProject, setWorkerRegion, setWorkerZone, setZone

Methods inherited from interface org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions

getGoogleApiTrace, setGoogleApiTrace

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

getUpdateCompatibilityVersion, isStreaming, setStreaming, setUpdateCompatibilityVersion, updateCompatibilityVersionLessThan

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

getAppName, setAppName

Method Detail

targetForRootUrl

@Internal
static java.lang.String targetForRootUrl(java.lang.String urlString)

Internal only utility for converting getPubsubRootUrl() (e.g. https://<host>) to an endpoint target, usable by GCP client libraries (e.g. <host>:443)

getPubsubRootUrl

@Default.String(value="https://pubsub.googleapis.com")
 @Hidden
java.lang.String getPubsubRootUrl()

Root URL for use with the Google Cloud Pub/Sub API.

setPubsubRootUrl

void setPubsubRootUrl(java.lang.String value)