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

Interface FirestoreOptions

  • All Superinterfaces:
    org.apache.beam.sdk.transforms.display.HasDisplayData, org.apache.beam.sdk.options.PipelineOptions
    public interface FirestoreOptions
extends org.apache.beam.sdk.options.PipelineOptions

    • Nested Class Summary

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

        org.apache.beam.sdk.options.PipelineOptions.AtomicLongFactory, org.apache.beam.sdk.options.PipelineOptions.CheckEnabled, org.apache.beam.sdk.options.PipelineOptions.DirectRunner, org.apache.beam.sdk.options.PipelineOptions.JobNameFactory, org.apache.beam.sdk.options.PipelineOptions.UserAgentFactory

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      @Nullable java.lang.String getEmulatorHost()
      A host port pair to allow connecting to a Cloud Firestore emulator instead of the live service.
      java.lang.String getFirestoreDb()
      The Firestore database ID to connect to.
      java.lang.String getFirestoreHost()
      A host port pair to allow connecting to a Cloud Firestore instead of the default live service.
      @Nullable java.lang.String getFirestoreProject()
      The Firestore project ID to connect to.
      void setEmulatorHost​(java.lang.String host)
      Define a host port pair to allow connecting to a Cloud Firestore emulator instead of the live service.
      void setFirestoreDb​(java.lang.String firestoreDb)
      Set the Firestore database ID to connect to.
      void setFirestoreHost​(java.lang.String host)
      Define a host port pair to allow connecting to a Cloud Firestore instead of the default live service.
      void setFirestoreProject​(java.lang.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, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

    • Method Detail

      • getEmulatorHost

        @Nullable java.lang.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​(java.lang.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)")
java.lang.String getFirestoreDb()
        The Firestore database ID to connect to. Note: named database is currently an internal feature in Firestore. Do not set this to anything other than "(default)".

      • setFirestoreDb

        void setFirestoreDb​(java.lang.String firestoreDb)
        Set the Firestore database ID to connect to.

      • getFirestoreHost

        @String("batch-firestore.googleapis.com:443")
java.lang.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​(java.lang.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 java.lang.String getFirestoreProject()
        The Firestore project ID to connect to.

      • setFirestoreProject

        void setFirestoreProject​(java.lang.String firestoreProject)
        Set the Firestore project ID, it will override the value from GcpOptions.getProject().