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

Interface BigQueryServices.StorageClient

  • All Superinterfaces:
    java.lang.AutoCloseable
    Enclosing interface:
    BigQueryServices
    public static interface BigQueryServices.StorageClient
extends java.lang.AutoCloseable
    An interface representing a client object for making calls to the BigQuery Storage API.

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      void close()
      Close the client object.
      com.google.cloud.bigquery.storage.v1.ReadSession createReadSession​(com.google.cloud.bigquery.storage.v1.CreateReadSessionRequest request)
      Create a new read session against an existing table.
      BigQueryServices.BigQueryServerStream<com.google.cloud.bigquery.storage.v1.ReadRowsResponse> readRows​(com.google.cloud.bigquery.storage.v1.ReadRowsRequest request)
      Read rows in the context of a specific read stream.
      BigQueryServices.BigQueryServerStream<com.google.cloud.bigquery.storage.v1.ReadRowsResponse> readRows​(com.google.cloud.bigquery.storage.v1.ReadRowsRequest request, java.lang.String fullTableId)  
      default void reportPendingMetrics()
      Call this method on Work Item thread to report outstanding metrics.
      com.google.cloud.bigquery.storage.v1.SplitReadStreamResponse splitReadStream​(com.google.cloud.bigquery.storage.v1.SplitReadStreamRequest request)  
      com.google.cloud.bigquery.storage.v1.SplitReadStreamResponse splitReadStream​(com.google.cloud.bigquery.storage.v1.SplitReadStreamRequest request, java.lang.String fullTableId)  

    • Method Detail

      • createReadSession

        com.google.cloud.bigquery.storage.v1.ReadSession createReadSession​(com.google.cloud.bigquery.storage.v1.CreateReadSessionRequest request)
        Create a new read session against an existing table. This method variant collects request count metric, table id in the request.

      • readRows

        BigQueryServices.BigQueryServerStream<com.google.cloud.bigquery.storage.v1.ReadRowsResponse> readRows​(com.google.cloud.bigquery.storage.v1.ReadRowsRequest request)
        Read rows in the context of a specific read stream.

      • readRows

        BigQueryServices.BigQueryServerStream<com.google.cloud.bigquery.storage.v1.ReadRowsResponse> readRows​(com.google.cloud.bigquery.storage.v1.ReadRowsRequest request,
                                                                                                      java.lang.String fullTableId)

      • splitReadStream

        com.google.cloud.bigquery.storage.v1.SplitReadStreamResponse splitReadStream​(com.google.cloud.bigquery.storage.v1.SplitReadStreamRequest request)

      • splitReadStream

        com.google.cloud.bigquery.storage.v1.SplitReadStreamResponse splitReadStream​(com.google.cloud.bigquery.storage.v1.SplitReadStreamRequest request,
                                                                             java.lang.String fullTableId)

      • reportPendingMetrics

        default void reportPendingMetrics()
        Call this method on Work Item thread to report outstanding metrics.

        Because incrementing metrics is only supported on the execution thread, callback thread that has pending metrics cannot report it directly.

      • close

        void close()
        Close the client object.

        The override is required since AutoCloseable allows the close method to raise an exception.

        Specified by:
        close in interface java.lang.AutoCloseable