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

Interface GcpOptions

All Superinterfaces:
GoogleApiDebugOptions, HasDisplayData, PipelineOptions
All Known Subinterfaces:
BigQueryOptions, CloudResourceManagerOptions, DataflowPipelineOptions, DataflowPipelineWorkerPoolOptions, DataflowWorkerHarnessOptions, GcsOptions, PubsubOptions, TestBigQueryOptions, TestDataflowPipelineOptions, TestPubsubOptions
public interface GcpOptions extends GoogleApiDebugOptions, PipelineOptions
Options used to configure Google Cloud Platform specific options such as the project and credentials.

These options defer to the application default credentials for authentication. See the Google Auth Library for alternative mechanisms for creating credentials.

  • Field Details

    • STREAMING_ENGINE_EXPERIMENT

      static final String STREAMING_ENGINE_EXPERIMENT
      Experiment to turn on the Streaming Engine experiment.
      See Also:

    • WINDMILL_SERVICE_EXPERIMENT

      @Deprecated static final String WINDMILL_SERVICE_EXPERIMENT
      Deprecated.
      Use STREAMING_ENGINE_EXPERIMENT instead.
      See Also:

  • Method Details

    • getProject

      @InstanceFactory(DefaultProjectFactory.class) String getProject()
      Project id to use when launching jobs.

    • setProject

      void setProject(String value)

    • getZone

      @Deprecated String getZone()
      Deprecated.
      Use getWorkerZone() instead.
      GCP availability zone for operations.

      Default is set on a per-service basis.

    • setZone

      @Deprecated void setZone(String value)
      Deprecated.
      Use setWorkerZone(java.lang.String) instead.

    • getWorkerRegion

      String getWorkerRegion()
      The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with getWorkerZone(). If neither workerRegion nor workerZone is specified, default to same value as region.

    • setWorkerRegion

      void setWorkerRegion(String workerRegion)

    • getWorkerZone

      String getWorkerZone()
      The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with getWorkerRegion(). If neither workerRegion nor workerZone is specified, the Dataflow service will choose a zone in region based on available capacity.

    • setWorkerZone

      void setWorkerZone(String workerZone)

    • getGcpOauthScopes

      @InstanceFactory(GcpOAuthScopesFactory.class) List<String> getGcpOauthScopes()
      Controls the OAuth scopes that will be requested when creating Credentials with the GcpCredentialFactory (which is the default CredentialFactory). If the credential or credential factory have been set then this field may do nothing.

    • setGcpOauthScopes

      void setGcpOauthScopes(List<String> oauthScopes)

    • getCredentialFactoryClass

      @Class(GcpCredentialFactory.class) Class<? extends CredentialFactory> getCredentialFactoryClass()
      The class of the credential factory that should be created and used to create credentials. If gcpCredential has not been set explicitly, an instance of this class will be constructed and used as a credential factory.

    • setCredentialFactoryClass

      void setCredentialFactoryClass(Class<? extends CredentialFactory> credentialFactoryClass)

    • getGcpCredential

      @InstanceFactory(GcpUserCredentialsFactory.class) com.google.auth.Credentials getGcpCredential()
      The credential instance that should be used to authenticate against GCP services. If no credential has been set explicitly, the default is to use the instance factory that constructs a credential based upon the currently set credentialFactoryClass.

    • setGcpCredential

      void setGcpCredential(com.google.auth.Credentials value)

    • getImpersonateServiceAccount

      @Nullable String getImpersonateServiceAccount()
      All API requests will be made as the given service account or target service account in an impersonation delegation chain instead of the currently selected account. You can specify either a single service account as the impersonator, or a comma-separated list of service accounts to create an impersonation delegation chain.

    • setImpersonateServiceAccount

      void setImpersonateServiceAccount(String impersonateServiceAccount)

    • isEnableStreamingEngine

      @InstanceFactory(EnableStreamingEngineFactory.class) boolean isEnableStreamingEngine()

    • setEnableStreamingEngine

      void setEnableStreamingEngine(boolean value)

    • getGcpTempLocation

      @InstanceFactory(GcpTempLocationFactory.class) @Nullable String getGcpTempLocation()
      A GCS path for storing temporary files in GCP.

      Its default to PipelineOptions.getTempLocation().

    • setGcpTempLocation

      void setGcpTempLocation(String value)

    • getDataflowKmsKey

      @Nullable String getDataflowKmsKey()
      GCP Cloud KMS key for Dataflow pipelines and buckets created by GcpTempLocationFactory.

    • setDataflowKmsKey

      void setDataflowKmsKey(String dataflowKmsKey)