Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
* Project roles affect your ability to run jobs or manage the project, while dataset roles affect
* how you can access or modify the data inside a project.
*
* @see <a href="https://cloud.google.com/bigquery/access-control">Access Control</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/access-control">Access Control</a>
*/
public final class Acl implements Serializable {

Expand All @@ -47,7 +47,9 @@ public final class Acl implements Serializable {
/**
* Dataset roles supported by BigQuery.
*
* @see <a href="https://cloud.google.com/bigquery/access-control#datasetroles">Dataset Roles</a>
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/access-control-basic-roles#dataset-basic-roles">Dataset
* Roles</a>
*/
public static final class Role extends StringEnumValue {
private static final long serialVersionUID = -1992679397135956912L;
Expand Down Expand Up @@ -298,7 +300,7 @@ public static final class Group extends Entity {

/**
* Creates a Group entity given its identifier. Identifier can be either a <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset.FIELDS.access">
* special group identifier</a> or a group email.
*/
public Group(String identifier) {
Expand All @@ -308,7 +310,7 @@ public Group(String identifier) {

/**
* @return Returns group's identifier, can be either a <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#access.specialGroup">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset.FIELDS.access">
* special group identifier</a> or a group email.
*/
public String getIdentifier() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ public interface BigQuery extends Service<BigQueryOptions>, AutoCloseable {
/**
* Fields of a BigQuery Dataset resource.
*
* @see <a href= "https://cloud.google.com/bigquery/docs/reference/v2/datasets#resource">Dataset
* @see <a href=
* "https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/datasets#resource:-dataset">Dataset
* Resource</a>
*/
enum DatasetField implements FieldSelector {
Expand Down Expand Up @@ -116,7 +117,8 @@ public String toString() {
/**
* Fields of a BigQuery Table resource.
*
* @see <a href= "https://cloud.google.com/bigquery/docs/reference/v2/tables#resource">Table
* @see <a href=
* "https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/tables#resource:-table">Table
* Resource</a>
*/
enum TableField implements FieldSelector {
Expand Down Expand Up @@ -160,9 +162,8 @@ public String getSelector() {
/**
* Metadata of a BigQuery Table.
*
* @see <a href=
* "https://cloud.google.com/bigquery/docs/reference/rest/v2/tables/get#tablemetadataview">Table
* Resource</a>
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/tables/get#tablemetadataview">TableMetadataView</a>
*/
enum TableMetadataView {
BASIC,
Expand All @@ -174,7 +175,8 @@ enum TableMetadataView {
/**
* Fields of a BigQuery Model resource.
*
* @see <a href= "https://cloud.google.com/bigquery/docs/reference/v2/models#resource">Model
* @see <a href=
* "https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/models#Model">Model
* Resource</a>
*/
enum ModelField implements FieldSelector {
Expand Down Expand Up @@ -209,7 +211,8 @@ public String getSelector() {
/**
* Fields of a BigQuery Routine resource.
*
* @see <a href= "https://cloud.google.com/bigquery/docs/reference/v2/routines#resource">Routine
* @see <a href=
* "https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/routines#resource:-routine">Routine
* Resource</a>
*/
enum RoutineField implements FieldSelector {
Expand Down Expand Up @@ -242,8 +245,8 @@ public String getSelector() {
/**
* Fields of a BigQuery Job resource.
*
* @see <a href= "https://cloud.google.com/bigquery/docs/reference/v2/jobs#resource">Job Resource
* </a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job">Job
* Resource</a>
*/
enum JobField implements FieldSelector {
CONFIGURATION("configuration"),
Expand Down Expand Up @@ -281,7 +284,7 @@ private DatasetListOption(BigQueryRpc.Option option, Object value) {

/**
* Returns an option to specify a label filter. @see <a href=
* "https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels">Filtering
* "https://docs.cloud.google.com/bigquery/docs/filtering-labels#filtering_datasets_using_labels">Filtering
* using labels</a>
*
* @param labelFilter In the form "labels.key:value"
Expand Down Expand Up @@ -351,11 +354,11 @@ public static DatasetOption fields(DatasetField... fields) {
* for conditional access policy binding in datasets must specify version 3. Datasets with no
* conditional role bindings in access policy may specify any valid value or leave the field
* unset. This field will be mapped to <a
* href="https://cloud.google.com/iam/docs/policies#versions">IAM Policy version</a> and will be
* used to fetch the policy from IAM. If unset or if 0 or 1 the value is used for a dataset with
* conditional bindings, access entry with condition will have role string appended by
* 'withcond' string followed by a hash value. Please refer to <a
* href="https://cloud.google.com/iam/docs/troubleshooting-withcond">Troubleshooting
* href="https://docs.cloud.google.com/iam/docs/allow-policies#versions">IAM Policy version</a>
* and will be used to fetch the policy from IAM. If unset or if 0 or 1 the value is used for a
* dataset with conditional bindings, access entry with condition will have role string appended
* by 'withcond' string followed by a hash value. Please refer to <a
* href="https://docs.cloud.google.com/iam/docs/troubleshooting-withcond">Troubleshooting
* withcond</a> for more details.
*/
public static DatasetOption accessPolicyVersion(Integer accessPolicyVersion) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public interface BigQueryDryRunResult {
/**
* Returns query parameters for standard SQL queries by extracting undeclare query parameters from
* the dry run job. See more information:
* https://developers.google.com/resources/api-libraries/documentation/bigquery/v2/java/latest/com/google/api/services/bigquery/model/JobStatistics2.html#getUndeclaredQueryParameters--
* https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatistics2.FIELDS.undeclared_query_parameters
*/
@BetaApi
List<Parameter> getQueryParameters() throws BigQuerySQLException;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,8 @@ public abstract class ConnectionSettings {
* Returns whether nested and repeated fields should be flattened. If set to {@code false} {@link
* ConnectionSettings.Builder#setAllowLargeResults(Boolean)} must be {@code true}.
*
* @see <a href="https://cloud.google.com/bigquery/docs/data#flatten">Flatten</a>
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/legacy-nested-repeated#flatten">Flatten</a>
*/
@Nullable
public abstract Boolean getFlattenResults();
Expand All @@ -103,7 +104,7 @@ public abstract class ConnectionSettings {
* Returns whether the job is allowed to create new tables.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.createDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationQuery.FIELDS.create_disposition">
* Create Disposition</a>
*/
@Nullable
Expand Down Expand Up @@ -137,7 +138,8 @@ public abstract class ConnectionSettings {
* query is allowed to create large results at a slight cost in performance. the query is allowed
* to create large results at a slight cost in performance.
*
* @see <a href="https://cloud.google.com/bigquery/querying-data#largequeryresults">Returning
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/writing-results#large-results">Returning
* Large Query Results</a>
*/
@Nullable
Expand All @@ -146,7 +148,8 @@ public abstract class ConnectionSettings {
/**
* Returns whether to create a new session.
*
* @see <a href="https://cloud.google.com/bigquery/docs/sessions-create">Create Sessions</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/sessions#create-session">Create
* Sessions</a>
*/
@Nullable
public abstract Boolean getCreateSession();
Expand Down Expand Up @@ -190,7 +193,7 @@ public abstract class ConnectionSettings {
* Returns the action that should occur if the destination table already exists.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.writeDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationQuery.FIELDS.write_disposition">
* Write Disposition</a>
*/
@Nullable
Expand Down Expand Up @@ -303,7 +306,7 @@ Builder withDefaultValues() {
* cache is only available when {@link ConnectionSettings.Builder#setDestinationTable(TableId)}
* is not set.
*
* @see <a href="https://cloud.google.com/bigquery/querying-data#querycaching">Query Caching</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/cached-results">Query Caching</a>
*/
public abstract Builder setUseQueryCache(Boolean useQueryCache);

Expand All @@ -312,7 +315,8 @@ Builder withDefaultValues() {
* ConnectionSettings.Builder#setAllowLargeResults(Boolean)} must be {@code true}. By default
* results are flattened.
*
* @see <a href="https://cloud.google.com/bigquery/docs/data#flatten">Flatten</a>
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/legacy-nested-repeated#flatten">Flatten</a>
*/
public abstract Builder setFlattenResults(Boolean flattenResults);

Expand Down Expand Up @@ -341,7 +345,7 @@ public abstract Builder setReadClientConnectionConfiguration(
* Sets whether the job is allowed to create tables.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.createDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationQuery.FIELDS.create_disposition">
* Create Disposition</a>
*/
public abstract Builder setCreateDisposition(CreateDisposition createDisposition);
Expand Down Expand Up @@ -389,7 +393,8 @@ public abstract Builder setDestinationEncryptionConfiguration(
* query is allowed to create large results at a slight cost in performance. If {@code true}
* {@link ConnectionSettings.Builder#setDestinationTable(TableId)} must be provided.
*
* @see <a href="https://cloud.google.com/bigquery/querying-data#largequeryresults">Returning
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/writing-results#large-results">Returning
* Large Query Results</a>
*/
public abstract Builder setAllowLargeResults(Boolean allowLargeResults);
Expand Down Expand Up @@ -441,7 +446,7 @@ public abstract Builder setTableDefinitions(
* Sets the action that should occur if the destination table already exists.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.query.writeDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationQuery.FIELDS.write_disposition">
* Write Disposition</a>
*/
public abstract Builder setWriteDisposition(WriteDisposition writeDisposition);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public Builder setDestinationTable(TableId destinationTable) {

/**
* Sets the supported operation types (COPY, CLONE, SNAPSHOT or RESTORE) in table copy job. More
* info: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#operationtype
* info: https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#operationtype
*/
public Builder setOperationType(String operationType) {
this.operationType = operationType;
Expand All @@ -145,7 +145,7 @@ public Builder setOperationType(String operationType) {
/**
* Sets the time when the destination table expires. Expired tables will be deleted and their
* storage reclaimed. More info:
* https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfigurationtablecopy
* https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationTableCopy.FIELDS.destination_expiration_time
*/
public Builder setDestinationExpirationTime(String destinationExpirationTime) {
this.destinationExpirationTime = destinationExpirationTime;
Expand All @@ -162,7 +162,7 @@ public Builder setDestinationEncryptionConfiguration(
* Sets whether the job is allowed to create new tables.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationTableCopy.FIELDS.create_disposition">
* Create Disposition</a>
*/
public Builder setCreateDisposition(JobInfo.CreateDisposition createDisposition) {
Expand All @@ -174,7 +174,7 @@ public Builder setCreateDisposition(JobInfo.CreateDisposition createDisposition)
* Sets the action that should occur if the destination table already exists.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationTableCopy.FIELDS.write_disposition">
* Write Disposition</a>
*/
public Builder setWriteDisposition(JobInfo.WriteDisposition writeDisposition) {
Expand Down Expand Up @@ -267,7 +267,7 @@ public EncryptionConfiguration getDestinationEncryptionConfiguration() {
* Returns whether the job is allowed to create new tables.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.createDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationTableCopy.FIELDS.create_disposition">
* Create Disposition</a>
*/
public JobInfo.CreateDisposition getCreateDisposition() {
Expand All @@ -278,7 +278,7 @@ public JobInfo.CreateDisposition getCreateDisposition() {
* Returns the action that should occur if the destination table already exists.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/reference/v2/jobs#configuration.copy.writeDisposition">
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobConfigurationTableCopy.FIELDS.write_disposition">
* Write Disposition</a>
*/
public JobInfo.WriteDisposition getWriteDisposition() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ public abstract static class Builder {
/**
* Sets the dataset's access control configuration.
*
* @see <a href="https://cloud.google.com/bigquery/access-control">Access Control</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/access-control">Access Control</a>
*/
public abstract Builder setAcl(List<Acl> acl);

Expand Down Expand Up @@ -123,7 +123,8 @@ public abstract static class Builder {
* Sets the geographic location where the dataset should reside. This property is experimental
* and might be subject to change or removed.
*
* @see <a href="https://cloud.google.com/bigquery/docs/reference/v2/datasets#location">Dataset
* @see <a
* href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/datasets#Dataset.FIELDS.location">Dataset
* Location</a>
*/
public abstract Builder setLocation(String location);
Expand Down Expand Up @@ -187,13 +188,13 @@ public abstract Builder setDefaultEncryptionConfiguration(
public abstract Builder setDefaultCollation(String defaultCollation);

/**
* Optional. The <a href="https://cloud.google.com/bigquery/docs/tags">tags</a> attached to this
* dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format,
* for example "123456789012/environment" where 123456789012 is the ID of the parent
* Optional. The <a href="https://docs.cloud.google.com/bigquery/docs/tags">tags</a> attached to
* this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced
* format, for example "123456789012/environment" where 123456789012 is the ID of the parent
* organization or project resource for this tag key. Tag value is expected to be the short
* name, for example "Production".
*
* @see <a href="https://cloud.google.com/iam/docs/tags-access-control#definitions">Tag
* @see <a href="https://docs.cloud.google.com/iam/docs/tags-access-control#definitions">Tag
* definitions</a> for more details.
* @param resourceTags resourceTags or {@code null} for none
*/
Expand Down Expand Up @@ -471,8 +472,8 @@ public DatasetId getDatasetId() {
* bigquery.update(builder.build()); // API request.
* }</pre>
*
* @see <a href="https://cloud.google.com/bigquery/docs/access-control">Access Control</a>
* @see <a href="https://cloud.google.com/bigquery/docs/conditions">Control access with IAM
* @see <a href="https://docs.cloud.google.com/bigquery/docs/access-control">Access Control</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/conditions">Control access with IAM
* Conditions</a>
*/
public List<Acl> getAcl() {
Expand Down Expand Up @@ -540,9 +541,7 @@ public Long getLastModified() {
/**
* Returns the geographic location where the dataset should reside.
*
* @see <a
* href="https://cloud.google.com/bigquery/docs/managing_jobs_datasets_projects#dataset-location">
* Dataset Location</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/locations">Dataset Location</a>
*/
public String getLocation() {
return location;
Expand All @@ -559,7 +558,8 @@ public String getSelfLink() {
/**
* Return a map for labels applied to the dataset.
*
* @see <a href="https://cloud.google.com/bigquery/docs/labeling-datasets">Labeling Datasets</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/adding-labels#adding_dataset_labels">
* Labeling Datasets</a>
*/
public Map<String, String> getLabels() {
return labels.userMap();
Expand Down Expand Up @@ -590,13 +590,13 @@ public Long getMaxTimeTravelHours() {
}

/**
* Optional. The <a href="https://cloud.google.com/bigquery/docs/tags">tags</a> attached to this
* dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format, for
* example "123456789012/environment" where 123456789012 is the ID of the parent organization or
* project resource for this tag key. Tag value is expected to be the short name, for example
* Optional. The <a href="https://docs.cloud.google.com/bigquery/docs/tags">tags</a> attached to
* this dataset. Tag keys are globally unique. Tag key is expected to be in the namespaced format,
* for example "123456789012/environment" where 123456789012 is the ID of the parent organization
* or project resource for this tag key. Tag value is expected to be the short name, for example
* "Production".
*
* @see <a href="https://cloud.google.com/iam/docs/tags-access-control#definitions">Tag
* @see <a href="https://docs.cloud.google.com/iam/docs/tags-access-control#definitions">Tag
* definitions</a> for more details.
* @return value or {@code null} for none
*/
Expand Down
Loading
Loading