Package google.registry.beam.common

Interface RegistryPipelineOptions

All Superinterfaces:

org.apache.beam.sdk.extensions.gcp.options.GcpOptions, org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions, org.apache.beam.sdk.transforms.display.HasDisplayData, org.apache.beam.sdk.options.PipelineOptions

All Known Subinterfaces:

ExpandBillingRecurrencesPipelineOptions, InvoicingPipelineOptions, RdePipelineOptions, ResaveAllEppResourcesPipelineOptions, Spec11PipelineOptions, WipeOutContactHistoryPiiPipelineOptions

public interface RegistryPipelineOptions
extends org.apache.beam.sdk.extensions.gcp.options.GcpOptions

Defines Nomulus-specific pipeline options, e.g. JPA configurations.

When using the Cloud Dataflow runner, users are recommended to set an upper bound on active database connections by setting the max number of pipeline worker threads using --maxNumWorkers and workerMachineType for batch pipelines, or --maxNumWorkers and --numberOfWorkerHarnessThreads for streaming pipelines.

Nested Class Summary

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

org.apache.beam.sdk.extensions.gcp.options.GcpOptions.DefaultProjectFactory, org.apache.beam.sdk.extensions.gcp.options.GcpOptions.EnableStreamingEngineFactory, org.apache.beam.sdk.extensions.gcp.options.GcpOptions.GcpOAuthScopesFactory, org.apache.beam.sdk.extensions.gcp.options.GcpOptions.GcpTempLocationFactory, org.apache.beam.sdk.extensions.gcp.options.GcpOptions.GcpUserCredentialsFactory

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

org.apache.beam.sdk.extensions.gcp.options.GoogleApiDebugOptions.GoogleApiTracer

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

org.apache.beam.sdk.options.PipelineOptions.AtomicLongFactory, org.apache.beam.sdk.options.PipelineOptions.CheckEnabled, org.apache.beam.sdk.options.PipelineOptions.DirectRunner, org.apache.beam.sdk.options.PipelineOptions.JobNameFactory, org.apache.beam.sdk.options.PipelineOptions.UserAgentFactory

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	Description
PersistenceModule.TransactionIsolationLevel	getIsolationOverride()
PersistenceModule.JpaTransactionManagerType	getJpaTransactionManagerType()
RegistryEnvironment	getRegistryEnvironment()
int	getSqlWriteBatchSize()
void	setIsolationOverride(PersistenceModule.TransactionIsolationLevel isolationOverride)
void	setJpaTransactionManagerType(PersistenceModule.JpaTransactionManagerType jpaTransactionManagerType)
void	setRegistryEnvironment(RegistryEnvironment environment)
void	setSqlWriteBatchSize(int sqlWriteBatchSize)
static RegistryPipelineComponent	toRegistryPipelineComponent(RegistryPipelineOptions options)
static void	validateRegistryPipelineOptions(RegistryPipelineOptions options)	Validates the GCP project and Registry environment settings in options.

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.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

getRegistryEnvironment

RegistryEnvironment getRegistryEnvironment()

setRegistryEnvironment

void setRegistryEnvironment(RegistryEnvironment environment)

getIsolationOverride

@Nullable
PersistenceModule.TransactionIsolationLevel getIsolationOverride()

setIsolationOverride

void setIsolationOverride(PersistenceModule.TransactionIsolationLevel isolationOverride)

getJpaTransactionManagerType

@Enum("REGULAR")
PersistenceModule.JpaTransactionManagerType getJpaTransactionManagerType()

setJpaTransactionManagerType

void setJpaTransactionManagerType(PersistenceModule.JpaTransactionManagerType jpaTransactionManagerType)

getSqlWriteBatchSize

@Integer(20)
int getSqlWriteBatchSize()

setSqlWriteBatchSize

void setSqlWriteBatchSize(int sqlWriteBatchSize)

toRegistryPipelineComponent

static RegistryPipelineComponent toRegistryPipelineComponent(RegistryPipelineOptions options)

validateRegistryPipelineOptions

static void validateRegistryPipelineOptions(RegistryPipelineOptions options)

Validates the GCP project and Registry environment settings in options. If project is undefined, it is set according to the Registry environment; if project is defined but inconsistent with the Registry environment, an IllegalArgumentException will be thrown.

This method may modify the system property ("google.registry.environment" which is defined in RegistryEnvironment). Tests calling this method must restore the original environment on completion.