Skip to content

bigquery.v1beta1.bigQueryTable

Index

Fields

fn new

new(name)

new returns an instance of BigQueryTable

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

fn spec.withClustering

withClustering(clustering)

"Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order."

fn spec.withClusteringMixin

withClusteringMixin(clustering)

"Specifies column names to use for data clustering. Up to four top-level columns are allowed, and should be specified in descending priority order."

Note: This function appends passed data to existing values

fn spec.withDescription

withDescription(description)

"The field description."

fn spec.withExpirationTime

withExpirationTime(expirationTime)

"The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed."

fn spec.withFriendlyName

withFriendlyName(friendlyName)

"A descriptive name for the table."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The tableId of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

fn spec.withSchema

withSchema(schema)

"A JSON schema for the table."

obj spec.datasetRef

fn spec.datasetRef.withExternal

withExternal(external)

"Allowed value: The name field of a BigQueryDataset resource."

fn spec.datasetRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.datasetRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.encryptionConfiguration

"Immutable. Specifies how the table should be encrypted. If left blank, the table will be encrypted with a Google-managed key; that process is transparent to the user."

fn spec.encryptionConfiguration.withKmsKeyVersion

withKmsKeyVersion(kmsKeyVersion)

"The self link or full name of the kms key version used to encrypt this table."

obj spec.encryptionConfiguration.kmsKeyRef

fn spec.encryptionConfiguration.kmsKeyRef.withExternal

withExternal(external)

"Allowed value: The selfLink field of a KMSCryptoKey resource."

fn spec.encryptionConfiguration.kmsKeyRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.encryptionConfiguration.kmsKeyRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.externalDataConfiguration

"Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table."

fn spec.externalDataConfiguration.withAutodetect

withAutodetect(autodetect)

"Let BigQuery try to autodetect the schema and format of the table."

fn spec.externalDataConfiguration.withCompression

withCompression(compression)

"The compression type of the data source. Valid values are \"NONE\" or \"GZIP\"."

fn spec.externalDataConfiguration.withIgnoreUnknownValues

withIgnoreUnknownValues(ignoreUnknownValues)

"Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false."

fn spec.externalDataConfiguration.withMaxBadRecords

withMaxBadRecords(maxBadRecords)

"The maximum number of bad records that BigQuery can ignore when reading data."

fn spec.externalDataConfiguration.withSchema

withSchema(schema)

"Immutable. A JSON schema for the external table. Schema is required for CSV and JSON formats and is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats when using external tables."

fn spec.externalDataConfiguration.withSourceFormat

withSourceFormat(sourceFormat)

"The data format. Supported values are: \"CSV\", \"GOOGLE_SHEETS\", \"NEWLINE_DELIMITED_JSON\", \"AVRO\", \"PARQUET\", \"ORC\" and \"DATASTORE_BACKUP\". To use \"GOOGLE_SHEETS\" the scopes must include \"googleapis.com/auth/drive.readonly\"."

fn spec.externalDataConfiguration.withSourceUris

withSourceUris(sourceUris)

"A list of the fully-qualified URIs that point to your data in Google Cloud."

fn spec.externalDataConfiguration.withSourceUrisMixin

withSourceUrisMixin(sourceUris)

"A list of the fully-qualified URIs that point to your data in Google Cloud."

Note: This function appends passed data to existing values

obj spec.externalDataConfiguration.csvOptions

"Additional properties to set if source_format is set to \"CSV\"."

fn spec.externalDataConfiguration.csvOptions.withAllowJaggedRows

withAllowJaggedRows(allowJaggedRows)

"Indicates if BigQuery should accept rows that are missing trailing optional columns."

fn spec.externalDataConfiguration.csvOptions.withAllowQuotedNewlines

withAllowQuotedNewlines(allowQuotedNewlines)

"Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."

fn spec.externalDataConfiguration.csvOptions.withEncoding

withEncoding(encoding)

"The character encoding of the data. The supported values are UTF-8 or ISO-8859-1."

fn spec.externalDataConfiguration.csvOptions.withFieldDelimiter

withFieldDelimiter(fieldDelimiter)

"The separator for fields in a CSV file."

fn spec.externalDataConfiguration.csvOptions.withQuote

withQuote(quote)

fn spec.externalDataConfiguration.csvOptions.withSkipLeadingRows

withSkipLeadingRows(skipLeadingRows)

"The number of rows at the top of a CSV file that BigQuery will skip when reading the data."

obj spec.externalDataConfiguration.googleSheetsOptions

"Additional options if source_format is set to \"GOOGLE_SHEETS\"."

fn spec.externalDataConfiguration.googleSheetsOptions.withRange

withRange(range)

"Range of a sheet to query from. Only used when non-empty. At least one of range or skip_leading_rows must be set. Typical format: \"sheet_name!top_left_cell_id:bottom_right_cell_id\" For example: \"sheet1!A1:B20\"."

fn spec.externalDataConfiguration.googleSheetsOptions.withSkipLeadingRows

withSkipLeadingRows(skipLeadingRows)

"The number of rows at the top of the sheet that BigQuery will skip when reading the data. At least one of range or skip_leading_rows must be set."

obj spec.externalDataConfiguration.hivePartitioningOptions

"When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification."

fn spec.externalDataConfiguration.hivePartitioningOptions.withMode

withMode(mode)

"When set, what mode of hive partitioning to use when reading data."

fn spec.externalDataConfiguration.hivePartitioningOptions.withRequirePartitionFilter

withRequirePartitionFilter(requirePartitionFilter)

"If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified."

fn spec.externalDataConfiguration.hivePartitioningOptions.withSourceUriPrefix

withSourceUriPrefix(sourceUriPrefix)

"When hive partition detection is requested, a common for all source uris must be required. The prefix must end immediately before the partition key encoding begins."

obj spec.materializedView

"If specified, configures this table as a materialized view."

fn spec.materializedView.withEnableRefresh

withEnableRefresh(enableRefresh)

"Specifies if BigQuery should automatically refresh materialized view when the base table is updated. The default is true."

fn spec.materializedView.withQuery

withQuery(query)

"Immutable. A query whose result is persisted."

fn spec.materializedView.withRefreshIntervalMs

withRefreshIntervalMs(refreshIntervalMs)

"Specifies maximum frequency at which this materialized view will be refreshed. The default is 1800000."

obj spec.rangePartitioning

"If specified, configures range-based partitioning for this table."

fn spec.rangePartitioning.withField

withField(field)

"Immutable. The field used to determine how to create a range-based partition."

obj spec.rangePartitioning.range

"Information required to partition based on ranges. Structure is documented below."

fn spec.rangePartitioning.range.withEnd

withEnd(end)

"End of the range partitioning, exclusive."

fn spec.rangePartitioning.range.withInterval

withInterval(interval)

"The width of each range within the partition."

fn spec.rangePartitioning.range.withStart

withStart(start)

"Start of the range partitioning, inclusive."

obj spec.timePartitioning

"If specified, configures time-based partitioning for this table."

fn spec.timePartitioning.withExpirationMs

withExpirationMs(expirationMs)

"Number of milliseconds for which to keep the storage for a partition."

fn spec.timePartitioning.withField

withField(field)

"Immutable. The field used to determine how to create a time-based partition. If time-based partitioning is enabled without this value, the table is partitioned based on the load time."

fn spec.timePartitioning.withRequirePartitionFilter

withRequirePartitionFilter(requirePartitionFilter)

"If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified."

fn spec.timePartitioning.withType

withType(type)

"The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively."

obj spec.view

"If specified, configures this table as a view."

fn spec.view.withQuery

withQuery(query)

"A query that BigQuery executes when the view is referenced."

fn spec.view.withUseLegacySql

withUseLegacySql(useLegacySql)

"Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL."