Documentation
¶
Overview ¶
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package bigquery provices methods and types for managing bigquery GCP resources.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Package beta defines operations in the declarative SDK.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Copyright 2026 Google LLC. All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- Constants
- Variables
- func DCLDatasetSchema() *dcl.Schema
- type Client
- func (c *Client) ApplyDataset(ctx context.Context, rawDesired *Dataset, opts ...dcl.ApplyOption) (*Dataset, error)
- func (c *Client) DeleteAllDataset(ctx context.Context, project string, filter func(*Dataset) bool) error
- func (c *Client) DeleteDataset(ctx context.Context, r *Dataset) error
- func (c *Client) GetDataset(ctx context.Context, r *Dataset) (*Dataset, error)
- func (c *Client) ListDataset(ctx context.Context, project string) (*DatasetList, error)
- func (c *Client) ListDatasetWithMaxResults(ctx context.Context, project string, pageSize int32) (*DatasetList, error)
- type Dataset
- type DatasetAccess
- type DatasetAccessRoutine
- type DatasetAccessView
- type DatasetDefaultEncryptionConfiguration
- type DatasetList
Constants ¶
const DatasetMaxPage = -1
Variables ¶
var YAML_dataset []byte
Functions ¶
func DCLDatasetSchema ¶ added in v1.10.3
Types ¶
type Client ¶
The Client is the base struct of all operations. This will receive the Get, Delete, List, and Apply operations on all resources.
func (*Client) ApplyDataset ¶ added in v1.4.0
func (*Client) DeleteAllDataset ¶ added in v1.4.0
func (c *Client) DeleteAllDataset(ctx context.Context, project string, filter func(*Dataset) bool) error
DeleteAllDataset deletes all resources that the filter functions returns true on.
func (*Client) DeleteDataset ¶ added in v1.4.0
func (*Client) GetDataset ¶ added in v1.4.0
func (*Client) ListDataset ¶ added in v1.4.0
func (*Client) ListDatasetWithMaxResults ¶ added in v1.4.0
type Dataset ¶ added in v1.4.0
type Dataset struct {
Etag *string `json:"etag"`
Id *string `json:"id"`
SelfLink *string `json:"selfLink"`
Name *string `json:"name"`
Project *string `json:"project"`
FriendlyName *string `json:"friendlyName"`
Description *string `json:"description"`
DefaultTableExpirationMs *string `json:"defaultTableExpirationMs"`
DefaultPartitionExpirationMs *string `json:"defaultPartitionExpirationMs"`
Labels map[string]string `json:"labels"`
Access []DatasetAccess `json:"access"`
CreationTime *int64 `json:"creationTime"`
LastModifiedTime *int64 `json:"lastModifiedTime"`
Location *string `json:"location"`
Published *bool `json:"published"`
DefaultEncryptionConfiguration *DatasetDefaultEncryptionConfiguration `json:"defaultEncryptionConfiguration"`
}
func (*Dataset) Describe ¶ added in v1.4.0
func (r *Dataset) Describe() dcl.ServiceTypeVersion
Describe returns a simple description of this resource to ensure that automated tools can identify it.
type DatasetAccess ¶ added in v1.4.0
type DatasetAccess struct {
Role *string `json:"role"`
UserByEmail *string `json:"userByEmail"`
GroupByEmail *string `json:"groupByEmail"`
Domain *string `json:"domain"`
SpecialGroup *string `json:"specialGroup"`
IamMember *string `json:"iamMember"`
View *DatasetAccessView `json:"view"`
Routine *DatasetAccessRoutine `json:"routine"`
// contains filtered or unexported fields
}
var EmptyDatasetAccess *DatasetAccess = &DatasetAccess{empty: true}
This object is used to assert a desired state where this DatasetAccess is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*DatasetAccess) Empty ¶ added in v1.4.0
func (r *DatasetAccess) Empty() bool
func (*DatasetAccess) HashCode ¶ added in v1.4.0
func (r *DatasetAccess) HashCode() string
func (*DatasetAccess) String ¶ added in v1.4.0
func (r *DatasetAccess) String() string
func (*DatasetAccess) UnmarshalJSON ¶ added in v1.4.0
func (r *DatasetAccess) UnmarshalJSON(data []byte) error
type DatasetAccessRoutine ¶ added in v1.4.0
type DatasetAccessRoutine struct {
ProjectId *string `json:"projectId"`
DatasetId *string `json:"datasetId"`
RoutineId *string `json:"routineId"`
// contains filtered or unexported fields
}
var EmptyDatasetAccessRoutine *DatasetAccessRoutine = &DatasetAccessRoutine{empty: true}
This object is used to assert a desired state where this DatasetAccessRoutine is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*DatasetAccessRoutine) Empty ¶ added in v1.4.0
func (r *DatasetAccessRoutine) Empty() bool
func (*DatasetAccessRoutine) HashCode ¶ added in v1.4.0
func (r *DatasetAccessRoutine) HashCode() string
func (*DatasetAccessRoutine) String ¶ added in v1.4.0
func (r *DatasetAccessRoutine) String() string
func (*DatasetAccessRoutine) UnmarshalJSON ¶ added in v1.4.0
func (r *DatasetAccessRoutine) UnmarshalJSON(data []byte) error
type DatasetAccessView ¶ added in v1.4.0
type DatasetAccessView struct {
ProjectId *string `json:"projectId"`
DatasetId *string `json:"datasetId"`
TableId *string `json:"tableId"`
// contains filtered or unexported fields
}
var EmptyDatasetAccessView *DatasetAccessView = &DatasetAccessView{empty: true}
This object is used to assert a desired state where this DatasetAccessView is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*DatasetAccessView) Empty ¶ added in v1.4.0
func (r *DatasetAccessView) Empty() bool
func (*DatasetAccessView) HashCode ¶ added in v1.4.0
func (r *DatasetAccessView) HashCode() string
func (*DatasetAccessView) String ¶ added in v1.4.0
func (r *DatasetAccessView) String() string
func (*DatasetAccessView) UnmarshalJSON ¶ added in v1.4.0
func (r *DatasetAccessView) UnmarshalJSON(data []byte) error
type DatasetDefaultEncryptionConfiguration ¶ added in v1.4.0
type DatasetDefaultEncryptionConfiguration struct {
KmsKeyName *string `json:"kmsKeyName"`
// contains filtered or unexported fields
}
var EmptyDatasetDefaultEncryptionConfiguration *DatasetDefaultEncryptionConfiguration = &DatasetDefaultEncryptionConfiguration{empty: true}
This object is used to assert a desired state where this DatasetDefaultEncryptionConfiguration is empty. Go lacks global const objects, but this object should be treated as one. Modifying this object will have undesirable results.
func (*DatasetDefaultEncryptionConfiguration) Empty ¶ added in v1.4.0
func (r *DatasetDefaultEncryptionConfiguration) Empty() bool
func (*DatasetDefaultEncryptionConfiguration) HashCode ¶ added in v1.4.0
func (r *DatasetDefaultEncryptionConfiguration) HashCode() string
func (*DatasetDefaultEncryptionConfiguration) String ¶ added in v1.4.0
func (r *DatasetDefaultEncryptionConfiguration) String() string
func (*DatasetDefaultEncryptionConfiguration) UnmarshalJSON ¶ added in v1.4.0
func (r *DatasetDefaultEncryptionConfiguration) UnmarshalJSON(data []byte) error
type DatasetList ¶ added in v1.4.0
type DatasetList struct {
Items []*Dataset
// contains filtered or unexported fields
}
func (*DatasetList) HasNext ¶ added in v1.4.0
func (l *DatasetList) HasNext() bool