BigQueryIO.Read.Bound (Google Cloud Dataflow SDK 1.9.1 API)

Google Cloud Dataflow SDK for Java, version 1.9.1

Class BigQueryIO.Read.Bound

    • Method Detail

      • named

        public BigQueryIO.Read.Bound named(String name)
        Returns a copy of this transform using the name associated with this transformation.

        Does not modify this object.

      • fromQuery

        public BigQueryIO.Read.Bound fromQuery(String query)
        Returns a copy of this transform that reads the results of the specified query.

        Does not modify this object.

        By default, the query results will be flattened -- see "flattenResults" in the Jobs documentation for more information. To disable flattening, use withoutResultFlattening().

        By default, the query will use BigQuery's legacy SQL dialect. To use the BigQuery Standard SQL dialect, use usingStandardSql().

      • usingStandardSql

        public BigQueryIO.Read.Bound usingStandardSql()
        Enables BigQuery's Standard SQL dialect when reading from a query.

        Only valid when a query is used (fromQuery(java.lang.String)). Setting this option when reading from a table will cause an error during validation.

      • validate

        public void validate(PInput input)
        Description copied from class: PTransform
        Called before invoking apply (which may be intercepted by the runner) to verify this transform is fully specified and applicable to the specified input.

        By default, does nothing.

        validate in class PTransform<PInput,PCollection<TableRow>>
      • populateDisplayData

        public void populateDisplayData(DisplayData.Builder builder)
        Description copied from class: PTransform
        Register display data for the given transform or component.

        populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

        By default, does not register any display data. Implementors may override this method to provide their own display data.

        Specified by:
        populateDisplayData in interface HasDisplayData
        populateDisplayData in class PTransform<PInput,PCollection<TableRow>>
        builder - The builder to populate with display data.
        See Also:
      • getTableProvider

        public ValueProvider<TableReference> getTableProvider()
        Returns the table to read, or null if reading from a query instead.
      • getTable

        public TableReference getTable()
        Returns the table to read, or null if reading from a query instead.
      • getQuery

        public String getQuery()
        Returns the query to be read, or null if reading from a table instead.
      • getQueryProvider

        public ValueProvider<String> getQueryProvider()
        Returns the query to be read, or null if reading from a table instead.
      • getValidate

        public boolean getValidate()
        Returns true if table validation is enabled.
      • getFlattenResults

        public Boolean getFlattenResults()
        Returns true/false if result flattening is enabled/disabled, or null if not applicable.
      • getUseLegacySql

        public Boolean getUseLegacySql()
        Returns true (false) if the query will (will not) use BigQuery's legacy SQL mode, or null if not applicable.