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

Interface BigQueryServices.StreamAppendClient

All Superinterfaces:
AutoCloseable
Enclosing interface:
BigQueryServices
public static interface BigQueryServices.StreamAppendClient extends AutoCloseable
An interface for appending records to a Storage API write stream.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.api.core.ApiFuture<com.google.cloud.bigquery.storage.v1.AppendRowsResponse>
    appendRows(long offset, com.google.cloud.bigquery.storage.v1.ProtoRows rows)
    Append rows to a Storage API write stream at the given offset.
    default long
    getInflightWaitSeconds()
    If the previous call to appendRows blocked due to flow control, returns how long the call blocked for.
    @Nullable com.google.cloud.bigquery.storage.v1.TableSchema
    getUpdatedSchema()
    If the table schema has been updated, returns the new schema.
    void
    pin()
    Pin this object.
    void
    unpin()
    Unpin this object.

    Methods inherited from interface java.lang.AutoCloseable

    close

  • Method Details

    • appendRows

      com.google.api.core.ApiFuture<com.google.cloud.bigquery.storage.v1.AppendRowsResponse> appendRows(long offset, com.google.cloud.bigquery.storage.v1.ProtoRows rows) throws Exception
      Append rows to a Storage API write stream at the given offset.
      Throws:
      Exception

    • getUpdatedSchema

      @Nullable com.google.cloud.bigquery.storage.v1.TableSchema getUpdatedSchema()
      If the table schema has been updated, returns the new schema. Otherwise returns null.

    • getInflightWaitSeconds

      default long getInflightWaitSeconds()
      If the previous call to appendRows blocked due to flow control, returns how long the call blocked for.

    • pin

      void pin()
      Pin this object. If close() is called before all pins are removed, the underlying resources will not be freed until all pins are removed.

    • unpin

      void unpin() throws Exception
      Unpin this object. If the object has been closed, this will release any underlying resources.
      Throws:
      Exception