Package org.apache.beam.sdk.io.gcp.firestore

Interface FirestoreOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

public interface FirestoreOptions
extends PipelineOptions

Nested Class Summary

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

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method	Description
@Nullable String	getEmulatorHost()	A host port pair to allow connecting to a Cloud Firestore emulator instead of the live service.
String	getFirestoreDb()	The Firestore database ID to connect to.
String	getFirestoreHost()	A host port pair to allow connecting to a Cloud Firestore instead of the default live service.
@Nullable String	getFirestoreProject()	The Firestore project ID to connect to.
void	setEmulatorHost(String host)	Define a host port pair to allow connecting to a Cloud Firestore emulator instead of the live service.
void	setFirestoreDb(String firestoreDb)	Set the Firestore database ID to connect to.
void	setFirestoreHost(String host)	Define a host port pair to allow connecting to a Cloud Firestore instead of the default live service.
void	setFirestoreProject(String firestoreProject)	Set the Firestore project ID, it will override the value from GcpOptions.getProject().

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getGbek, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setGbek, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Details

getEmulatorHost

@Nullable String getEmulatorHost()

A host port pair to allow connecting to a Cloud Firestore emulator instead of the live service. The value passed to this method will take precedent if the FIRESTORE_EMULATOR_HOST environment variable is also set.

Returns:

the string representation of a host and port pair to be used when constructing Cloud Firestore clients.

See Also:

• FirestoreOptions.Builder.setEmulatorHost(java.lang.String)

setEmulatorHost

void setEmulatorHost(String host)

Define a host port pair to allow connecting to a Cloud Firestore emulator instead of the live service. The value passed to this method will take precedent if the FIRESTORE_EMULATOR_HOST environment variable is also set.

Parameters:

host - the emulator host and port to connect to

See Also:

• FirestoreOptions.Builder.setEmulatorHost(java.lang.String)

getFirestoreDb

@String("(default)")
String getFirestoreDb()

The Firestore database ID to connect to.

setFirestoreDb

void setFirestoreDb(String firestoreDb)

Set the Firestore database ID to connect to.

getFirestoreHost

@String("batch-firestore.googleapis.com:443")
String getFirestoreHost()

A host port pair to allow connecting to a Cloud Firestore instead of the default live service.

Returns:

the string representation of a host and port pair to be used when constructing Cloud Firestore clients.

setFirestoreHost

void setFirestoreHost(String host)

Define a host port pair to allow connecting to a Cloud Firestore instead of the default live service.

Parameters:

host - the host and port to connect to

getFirestoreProject

@Nullable String getFirestoreProject()

The Firestore project ID to connect to.

setFirestoreProject

void setFirestoreProject(String firestoreProject)

Set the Firestore project ID, it will override the value from GcpOptions.getProject().