public interface GcsOptions extends ApplicationNameOptions, GcpOptions, PipelineOptions
Modifier and Type | Interface and Description |
---|---|
static class |
GcsOptions.ExecutorServiceFactory
Returns the default
ExecutorService to use within the Apache Beam SDK. |
static class |
GcsOptions.PathValidatorFactory
Creates a
PathValidator object using the class specified in getPathValidatorClass() . |
GcpOptions.DefaultProjectFactory, GcpOptions.EnableStreamingEngineFactory, GcpOptions.GcpOAuthScopesFactory, GcpOptions.GcpTempLocationFactory, GcpOptions.GcpUserCredentialsFactory
GoogleApiDebugOptions.GoogleApiTracer
PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory
STREAMING_ENGINE_EXPERIMENT, WINDMILL_SERVICE_EXPERIMENT
Modifier and Type | Method and Description |
---|---|
java.util.concurrent.ExecutorService |
getExecutorService()
Deprecated.
use
ExecutorOptions.getScheduledExecutorService() instead |
java.lang.String |
getGcsEndpoint()
GCS endpoint to use.
|
java.lang.Boolean |
getGcsPerformanceMetrics()
If true, reports metrics of certain operations, such as batch copies.
|
@Nullable java.lang.Integer |
getGcsUploadBufferSizeBytes()
The buffer size (in bytes) to use when uploading files to GCS.
|
GcsUtil |
getGcsUtil()
The GcsUtil instance that should be used to communicate with Google Cloud Storage.
|
PathValidator |
getPathValidator()
The path validator instance that should be used to validate paths.
|
java.lang.Class<? extends PathValidator> |
getPathValidatorClass()
The class of the validator that should be created and used to validate paths.
|
void |
setExecutorService(java.util.concurrent.ExecutorService value)
Deprecated.
use
ExecutorOptions.setScheduledExecutorService(java.util.concurrent.ScheduledExecutorService) instead. If set, it may
result in multiple ExecutorServices, and therefore thread pools, in the runtime. |
void |
setGcsEndpoint(java.lang.String value) |
void |
setGcsPerformanceMetrics(java.lang.Boolean reportPerformanceMetrics) |
void |
setGcsUploadBufferSizeBytes(@Nullable java.lang.Integer bytes) |
void |
setGcsUtil(GcsUtil value) |
void |
setPathValidator(PathValidator validator) |
void |
setPathValidatorClass(java.lang.Class<? extends PathValidator> validatorClass) |
getAppName, setAppName
getCredentialFactoryClass, getDataflowKmsKey, getGcpCredential, getGcpOauthScopes, getGcpTempLocation, getImpersonateServiceAccount, getProject, getWorkerRegion, getWorkerZone, getZone, isEnableStreamingEngine, setCredentialFactoryClass, setDataflowKmsKey, setEnableStreamingEngine, setGcpCredential, setGcpOauthScopes, setGcpTempLocation, setImpersonateServiceAccount, setProject, setWorkerRegion, setWorkerZone, setZone
getGoogleApiTrace, setGoogleApiTrace
as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent
populateDisplayData
@Default.InstanceFactory(value=GcsUtil.GcsUtilFactory.class) @Hidden GcsUtil getGcsUtil()
void setGcsUtil(GcsUtil value)
@Default.InstanceFactory(value=GcsOptions.ExecutorServiceFactory.class) @Hidden @Deprecated java.util.concurrent.ExecutorService getExecutorService()
ExecutorOptions.getScheduledExecutorService()
insteadExecutorOptions.getScheduledExecutorService()
.@Deprecated void setExecutorService(java.util.concurrent.ExecutorService value)
ExecutorOptions.setScheduledExecutorService(java.util.concurrent.ScheduledExecutorService)
instead. If set, it may
result in multiple ExecutorServices, and therefore thread pools, in the runtime.@Hidden java.lang.String getGcsEndpoint()
void setGcsEndpoint(java.lang.String value)
@Nullable java.lang.Integer getGcsUploadBufferSizeBytes()
AsyncWriteChannelOptions.getUploadChunkSize()
for more information on the restrictions
and performance implications of this value.void setGcsUploadBufferSizeBytes(@Nullable java.lang.Integer bytes)
@Default.Class(value=GcsPathValidator.class) java.lang.Class<? extends PathValidator> getPathValidatorClass()
void setPathValidatorClass(java.lang.Class<? extends PathValidator> validatorClass)
@Default.InstanceFactory(value=GcsOptions.PathValidatorFactory.class) PathValidator getPathValidator()
void setPathValidator(PathValidator validator)
@Default.Boolean(value=false) java.lang.Boolean getGcsPerformanceMetrics()
void setGcsPerformanceMetrics(java.lang.Boolean reportPerformanceMetrics)