com.google.cloud.dataflow.sdk.options

Interface GcpOptions

All Superinterfaces:

GoogleApiDebugOptions, PipelineOptions

All Known Subinterfaces:

BigQueryOptions, BlockingDataflowPipelineOptions, DataflowPipelineOptions, DataflowWorkerHarnessOptions, DirectPipelineOptions, GcsOptions, StreamingOptions, TestDataflowPipelineOptions

public interface GcpOptions
extends GoogleApiDebugOptions, PipelineOptions

Options used to configure Google Cloud Platform project and credentials.

These options configure which of the following 4 different mechanisms for obtaining a credential are used:

1. It can fetch the application default credentials.
2. It can run the gcloud tool in a subprocess to obtain a credential. This is the preferred mechanism. The property "GCloudPath" can be used to specify where we search for gcloud data.
3. The user can specify a client secrets file and go through the OAuth2 webflow. The credential will then be cached in the user's home directory for reuse.
4. The user can specify a file containing a service account private key along with the service account name.

The default mechanism is to use the application default credentials falling back to gcloud. The other options can be used by setting the corresponding properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	GcpOptions.CredentialDirFactory Returns the default credential directory of ${user.home}/.store/data-flow.
static class	GcpOptions.DefaultProjectFactory Attempts to get infer the default project based upon the environment this application is executing within.
static class	GcpOptions.GcpUserCredentialsFactory Attempts to load the GCP credentials.

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.options.GoogleApiDebugOptions

GoogleApiDebugOptions.GoogleApiTracer

Nested classes/interfaces inherited from interface com.google.cloud.dataflow.sdk.options.PipelineOptions

PipelineOptions.CheckEnabled

Method Summary

Modifier and Type	Method and Description
String	getCredentialDir() Directory for storing dataflow credentials after execution of the OAuth 2 webflow.
Class<? extends com.google.cloud.dataflow.sdk.util.CredentialFactory>	getCredentialFactoryClass() The class of the credential factory that should be created and used to create credentials.
String	getCredentialId() This option controls which credential store to use when creating the credentials using the OAuth 2 webflow.
com.google.api.client.auth.oauth2.Credential	getGcpCredential() The credential instance that should be used to authenticate against GCP services.
String	getProject() Project id to use when launching jobs.
String	getSecretsFile() This option controls which file to use when attempting to create the credentials using the OAuth 2 webflow.
String	getServiceAccountKeyfile() This option controls which file to use when attempting to create the credentials using the service account method.
String	getServiceAccountName() This option controls which service account to use when attempting to create the credentials using the service account method.
void	setCredentialDir(String value)
void	setCredentialFactoryClass(Class<? extends com.google.cloud.dataflow.sdk.util.CredentialFactory> credentialFactoryClass)
void	setCredentialId(String value)
void	setGcpCredential(com.google.api.client.auth.oauth2.Credential value)
void	setProject(String value)
void	setSecretsFile(String value)
void	setServiceAccountKeyfile(String value)
void	setServiceAccountName(String value)

Methods inherited from interface com.google.cloud.dataflow.sdk.options.GoogleApiDebugOptions

getGoogleApiTrace, setGoogleApiTrace

Methods inherited from interface com.google.cloud.dataflow.sdk.options.PipelineOptions

as, cloneAs, getRunner, getStableUniqueNames, setRunner, setStableUniqueNames

Method Detail

getProject

String getProject()

Project id to use when launching jobs.

setProject

void setProject(String value)

getServiceAccountKeyfile

String getServiceAccountKeyfile()

This option controls which file to use when attempting to create the credentials using the service account method.

This option if specified, needs be combined with the serviceAccountName.

setServiceAccountKeyfile

void setServiceAccountKeyfile(String value)

getServiceAccountName

String getServiceAccountName()

This option controls which service account to use when attempting to create the credentials using the service account method.

This option if specified, needs be combined with the serviceAccountKeyfile.

setServiceAccountName

void setServiceAccountName(String value)

getSecretsFile

String getSecretsFile()

This option controls which file to use when attempting to create the credentials using the OAuth 2 webflow. After the OAuth2 webflow, the credentials will be stored within credentialDir.

setSecretsFile

void setSecretsFile(String value)

getCredentialId

String getCredentialId()

This option controls which credential store to use when creating the credentials using the OAuth 2 webflow.

setCredentialId

void setCredentialId(String value)

getCredentialDir

String getCredentialDir()

Directory for storing dataflow credentials after execution of the OAuth 2 webflow. Defaults to using the $HOME/.store/data-flow directory.

setCredentialDir

void setCredentialDir(String value)

getCredentialFactoryClass

Class<? extends com.google.cloud.dataflow.sdk.util.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 com.google.cloud.dataflow.sdk.util.CredentialFactory> credentialFactoryClass)

getGcpCredential

com.google.api.client.auth.oauth2.Credential 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.api.client.auth.oauth2.Credential value)