File tree Expand file tree Collapse file tree
java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -707,11 +707,34 @@ public Builder setReservation(String reservation) {
707707 return this ;
708708 }
709709
710+ /**
711+ * Sets the query results response format. Defaults to {@link
712+ * QueryResultsFormat#STRUCT_ENCODING}.
713+ *
714+ * <p>When set to {@link QueryResultsFormat#ARROW}, query results are returned in binary Apache
715+ * Arrow format, utilizing gRPC Storage Read streams for subsequent pages.
716+ *
717+ * <p><b>Prerequisite:</b> Requires the BigQuery Storage Read API ({@code
718+ * bigquerystorage.googleapis.com}) to be enabled on your GCP project and your credentials to
719+ * have Storage Read permissions (e.g. {@code bigquery.readsessions.create}).
720+ *
721+ * @param queryResultsFormat the format for query result payloads
722+ * @return the Builder
723+ */
710724 public Builder setQueryResultsFormat (QueryResultsFormat queryResultsFormat ) {
711725 this .queryResultsFormat = queryResultsFormat ;
712726 return this ;
713727 }
714728
729+ /**
730+ * Sets Arrow serialization options. Defaults to null.
731+ *
732+ * <p>Note: Only applied in the request payload when {@code queryResultsFormat} is {@code
733+ * ARROW}.
734+ *
735+ * @param arrowSerializationOptions the Arrow serialization options to set
736+ * @return the Builder
737+ */
715738 public Builder setArrowSerializationOptions (
716739 ArrowSerializationOptions arrowSerializationOptions ) {
717740 this .arrowSerializationOptions = arrowSerializationOptions ;
You can’t perform that action at this time.
0 commit comments