com.google.cloud.dataflow.sdk.options

Interface GcpOptions

All Superinterfaces:

PipelineOptions

All Known Subinterfaces:

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

public interface GcpOptions
extends 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.GcpUserCredentialsFactory Attempts to load the user credentials.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCredentialDir() Directory for storing dataflow credentials.
java.lang.String	getCredentialId()
java.lang.String	getGCloudPath()
com.google.api.client.auth.oauth2.Credential	getGcpCredential() Alternative Google Cloud Platform Credential.
java.lang.String	getProject() Project id to use when launching jobs.
java.lang.String	getSecretsFile() This option controls which file to use when attempting to create the credentials using the OAuth 2 webflow.
java.lang.String	getServiceAccountKeyfile() This option controls which file to use when attempting to create the credentials using the service account method.
java.lang.String	getServiceAccountName() This option controls which service account to use when attempting to create the credentials using the service account method.
void	setCredentialDir(java.lang.String value)
void	setCredentialId(java.lang.String value)
void	setGCloudPath(java.lang.String value)
void	setGcpCredential(com.google.api.client.auth.oauth2.Credential value)
void	setProject(java.lang.String value)
void	setSecretsFile(java.lang.String value)
void	setServiceAccountKeyfile(java.lang.String value)
void	setServiceAccountName(java.lang.String value)

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

as, getRunner, setRunner

Method Detail

getProject

java.lang.String getProject()

Project id to use when launching jobs.

setProject

void setProject(java.lang.String value)

getSecretsFile

java.lang.String getSecretsFile()

This option controls which file to use when attempting to create the credentials using the OAuth 2 webflow.

setSecretsFile

void setSecretsFile(java.lang.String value)

getServiceAccountKeyfile

java.lang.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(java.lang.String value)

getServiceAccountName

java.lang.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(java.lang.String value)

getGCloudPath

java.lang.String getGCloudPath()

setGCloudPath

void setGCloudPath(java.lang.String value)

getCredentialDir

java.lang.String getCredentialDir()

Directory for storing dataflow credentials.

setCredentialDir

void setCredentialDir(java.lang.String value)

getCredentialId

java.lang.String getCredentialId()

setCredentialId

void setCredentialId(java.lang.String value)

getGcpCredential

com.google.api.client.auth.oauth2.Credential getGcpCredential()

Alternative Google Cloud Platform Credential.

setGcpCredential

void setGcpCredential(com.google.api.client.auth.oauth2.Credential value)