Skip to content

Commit

Permalink
fix: Update experimental methods documentation to @internalapi (#3552)
Browse files Browse the repository at this point in the history
* docs: Update experimental methods documentation to @internalapi

* docs: Update experimental methods documentation to @internalapi
  • Loading branch information
PhongChuong authored Oct 31, 2024
1 parent bd24fd8 commit 20826f1
Showing 1 changed file with 17 additions and 15 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package com.google.cloud.bigquery;

import com.google.api.core.InternalApi;
import com.google.cloud.bigquery.JobInfo.CreateDisposition;
import com.google.cloud.bigquery.JobInfo.SchemaUpdateOption;
import com.google.cloud.bigquery.JobInfo.WriteDisposition;
Expand Down Expand Up @@ -99,17 +100,17 @@ interface Builder {
Builder setIgnoreUnknownValues(Boolean ignoreUnknownValues);

/**
* [Experimental] Sets options allowing the schema of the destination table to be updated as a
* side effect of the load job. Schema update options are supported in two cases: when
* writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination
* table is a partition of a table, specified by partition decorators. For normal tables,
* WRITE_TRUNCATE will always overwrite the schema.
* Sets options allowing the schema of the destination table to be updated as a side effect of
* the load job. Schema update options are supported in two cases: when writeDisposition is
* WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a
* partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE
* will always overwrite the schema.
*/
@InternalApi
Builder setSchemaUpdateOptions(List<SchemaUpdateOption> schemaUpdateOptions);

/**
* [Experimental] Sets automatic inference of the options and schema for CSV and JSON sources.
*/
/** Sets automatic inference of the options and schema for CSV and JSON sources. */
@InternalApi
Builder setAutodetect(Boolean autodetect);

/** Sets the time partitioning specification for the destination table. */
Expand Down Expand Up @@ -202,18 +203,19 @@ interface Builder {
DatastoreBackupOptions getDatastoreBackupOptions();

/**
* [Experimental] Returns options allowing the schema of the destination table to be updated as a
* side effect of the load job. Schema update options are supported in two cases: when
* writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination
* table is a partition of a table, specified by partition decorators. For normal tables,
* WRITE_TRUNCATE will always overwrite the schema.
* Returns options allowing the schema of the destination table to be updated as a side effect of
* the load job. Schema update options are supported in two cases: when writeDisposition is
* WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition
* of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always
* overwrite the schema.
*/
@InternalApi
List<SchemaUpdateOption> getSchemaUpdateOptions();

/**
* [Experimental] Returns whether automatic inference of the options and schema for CSV and JSON
* sources is set.
* Returns whether automatic inference of the options and schema for CSV and JSON sources is set.
*/
@InternalApi
Boolean getAutodetect();

/** Returns the time partitioning specification defined for the destination table. */
Expand Down

0 comments on commit 20826f1

Please sign in to comment.