Skip to content

bigquery.v1beta1.dataset

"Dataset is the Schema for the Datasets API. Datasets allow you to organize and control access to your tables."

Index

Fields

fn new

new(name)

new returns an instance of Dataset

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

"DatasetSpec defines the desired state of Dataset"

fn spec.withDeletionPolicy

withDeletionPolicy(deletionPolicy)

"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"

fn spec.withManagementPolicies

withManagementPolicies(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

fn spec.withManagementPoliciesMixin

withManagementPoliciesMixin(managementPolicies)

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"

Note: This function appends passed data to existing values

obj spec.forProvider

fn spec.forProvider.withAccess

withAccess(access)

"An array of objects that define dataset access for one or more entities. Structure is documented below."

fn spec.forProvider.withAccessMixin

withAccessMixin(access)

"An array of objects that define dataset access for one or more entities. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDefaultCollation

withDefaultCollation(defaultCollation)

"Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported:"

fn spec.forProvider.withDefaultEncryptionConfiguration

withDefaultEncryptionConfiguration(defaultEncryptionConfiguration)

"The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below."

fn spec.forProvider.withDefaultEncryptionConfigurationMixin

withDefaultEncryptionConfigurationMixin(defaultEncryptionConfiguration)

"The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.withDefaultPartitionExpirationMs

withDefaultPartitionExpirationMs(defaultPartitionExpirationMs)

"The default partition expiration for all partitioned tables in the dataset, in milliseconds."

fn spec.forProvider.withDefaultTableExpirationMs

withDefaultTableExpirationMs(defaultTableExpirationMs)

"The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour)."

fn spec.forProvider.withDeleteContentsOnDestroy

withDeleteContentsOnDestroy(deleteContentsOnDestroy)

"If set to true, delete all the tables in the dataset when destroying the resource; otherwise, destroying the resource will fail if tables are present."

fn spec.forProvider.withDescription

withDescription(description)

"A user-friendly description of the dataset"

fn spec.forProvider.withFriendlyName

withFriendlyName(friendlyName)

"A descriptive name for the dataset"

fn spec.forProvider.withIsCaseInsensitive

withIsCaseInsensitive(isCaseInsensitive)

"TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references."

fn spec.forProvider.withLabels

withLabels(labels)

"The labels associated with this dataset. You can use these to organize and group your datasets"

fn spec.forProvider.withLabelsMixin

withLabelsMixin(labels)

"The labels associated with this dataset. You can use these to organize and group your datasets"

Note: This function appends passed data to existing values

fn spec.forProvider.withLocation

withLocation(location)

"The geographic location where the dataset should reside. See official docs."

fn spec.forProvider.withMaxTimeTravelHours

withMaxTimeTravelHours(maxTimeTravelHours)

"Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days)."

fn spec.forProvider.withProject

withProject(project)

"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."

obj spec.forProvider.access

"An array of objects that define dataset access for one or more entities. Structure is documented below."

fn spec.forProvider.access.withDataset

withDataset(dataset)

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

fn spec.forProvider.access.withDatasetMixin

withDatasetMixin(dataset)

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.access.withDomain

withDomain(domain)

"A domain to grant access to. Any users signed in with the domain specified will be granted the specified access"

fn spec.forProvider.access.withGroupByEmail

withGroupByEmail(groupByEmail)

"An email address of a Google Group to grant access to."

fn spec.forProvider.access.withRole

withRole(role)

"Describes the rights granted to the user specified by the other member of the access object. Basic, predefined, and custom roles are supported. Predefined roles that have equivalent basic roles are swapped by the API to their basic counterparts. See official docs."

fn spec.forProvider.access.withRoutine

withRoutine(routine)

"A routine from a different dataset to grant access to. Queries executed against that routine will have read access to tables in this dataset. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. Structure is documented below."

fn spec.forProvider.access.withRoutineMixin

withRoutineMixin(routine)

"A routine from a different dataset to grant access to. Queries executed against that routine will have read access to tables in this dataset. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.access.withSpecialGroup

withSpecialGroup(specialGroup)

"A special group to grant access to. Possible values include:"

fn spec.forProvider.access.withUserByEmail

withUserByEmail(userByEmail)

"An email address of a user to grant access to. For example: fred@example.com"

fn spec.forProvider.access.withView

withView(view)

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

fn spec.forProvider.access.withViewMixin

withViewMixin(view)

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.forProvider.access.dataset

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

fn spec.forProvider.access.dataset.withDataset

withDataset(dataset)

"The dataset this entry applies to Structure is documented below."

fn spec.forProvider.access.dataset.withDatasetMixin

withDatasetMixin(dataset)

"The dataset this entry applies to Structure is documented below."

Note: This function appends passed data to existing values

fn spec.forProvider.access.dataset.withTargetTypes

withTargetTypes(targetTypes)

"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS"

fn spec.forProvider.access.dataset.withTargetTypesMixin

withTargetTypesMixin(targetTypes)

"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS"

Note: This function appends passed data to existing values

obj spec.forProvider.access.dataset.dataset

"The dataset this entry applies to Structure is documented below."

fn spec.forProvider.access.dataset.dataset.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.access.dataset.dataset.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

obj spec.forProvider.access.dataset.dataset.datasetIdRef

"Reference to a Dataset in bigquery to populate datasetId."

fn spec.forProvider.access.dataset.dataset.datasetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.access.dataset.dataset.datasetIdRef.policy

"Policies for referencing."

fn spec.forProvider.access.dataset.dataset.datasetIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.dataset.dataset.datasetIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.dataset.dataset.datasetIdSelector

"Selector for a Dataset in bigquery to populate datasetId."

fn spec.forProvider.access.dataset.dataset.datasetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.access.dataset.dataset.datasetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.access.dataset.dataset.datasetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.access.dataset.dataset.datasetIdSelector.policy

"Policies for selection."

fn spec.forProvider.access.dataset.dataset.datasetIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.dataset.dataset.datasetIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine

"A routine from a different dataset to grant access to. Queries executed against that routine will have read access to tables in this dataset. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. Structure is documented below."

fn spec.forProvider.access.routine.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.access.routine.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.forProvider.access.routine.withRoutineId

withRoutineId(routineId)

"The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters."

obj spec.forProvider.access.routine.datasetIdRef

"Reference to a Routine in bigquery to populate datasetId."

fn spec.forProvider.access.routine.datasetIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.access.routine.datasetIdRef.policy

"Policies for referencing."

fn spec.forProvider.access.routine.datasetIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.datasetIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine.datasetIdSelector

"Selector for a Routine in bigquery to populate datasetId."

fn spec.forProvider.access.routine.datasetIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.access.routine.datasetIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.access.routine.datasetIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.access.routine.datasetIdSelector.policy

"Policies for selection."

fn spec.forProvider.access.routine.datasetIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.datasetIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine.projectIdRef

"Reference to a Routine in bigquery to populate projectId."

fn spec.forProvider.access.routine.projectIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.access.routine.projectIdRef.policy

"Policies for referencing."

fn spec.forProvider.access.routine.projectIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.projectIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine.projectIdSelector

"Selector for a Routine in bigquery to populate projectId."

fn spec.forProvider.access.routine.projectIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.access.routine.projectIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.access.routine.projectIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.access.routine.projectIdSelector.policy

"Policies for selection."

fn spec.forProvider.access.routine.projectIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.projectIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine.routineIdRef

"Reference to a Routine in bigquery to populate routineId."

fn spec.forProvider.access.routine.routineIdRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.access.routine.routineIdRef.policy

"Policies for referencing."

fn spec.forProvider.access.routine.routineIdRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.routineIdRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.routine.routineIdSelector

"Selector for a Routine in bigquery to populate routineId."

fn spec.forProvider.access.routine.routineIdSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.access.routine.routineIdSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.access.routine.routineIdSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.access.routine.routineIdSelector.policy

"Policies for selection."

fn spec.forProvider.access.routine.routineIdSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.routine.routineIdSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.userByEmailRef

"Reference to a ServiceAccount in cloudplatform to populate userByEmail."

fn spec.forProvider.access.userByEmailRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.access.userByEmailRef.policy

"Policies for referencing."

fn spec.forProvider.access.userByEmailRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.userByEmailRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.userByEmailSelector

"Selector for a ServiceAccount in cloudplatform to populate userByEmail."

fn spec.forProvider.access.userByEmailSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.access.userByEmailSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.access.userByEmailSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.access.userByEmailSelector.policy

"Policies for selection."

fn spec.forProvider.access.userByEmailSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.access.userByEmailSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.access.view

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

fn spec.forProvider.access.view.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.forProvider.access.view.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.forProvider.access.view.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.forProvider.defaultEncryptionConfiguration

"The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below."

fn spec.forProvider.defaultEncryptionConfiguration.withKmsKeyName

withKmsKeyName(kmsKeyName)

"Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key."

obj spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameRef

"Reference to a CryptoKey in kms to populate kmsKeyName."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameRef.withName

withName(name)

"Name of the referenced object."

obj spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameRef.policy

"Policies for referencing."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector

"Selector for a CryptoKey in kms to populate kmsKeyName."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.withMatchControllerRef

withMatchControllerRef(matchControllerRef)

"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.withMatchLabels

withMatchLabels(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.withMatchLabelsMixin

withMatchLabelsMixin(matchLabels)

"MatchLabels ensures an object with matching labels is selected."

Note: This function appends passed data to existing values

obj spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.policy

"Policies for selection."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.forProvider.defaultEncryptionConfiguration.kmsKeyNameSelector.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.initProvider

"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."

fn spec.initProvider.withAccess

withAccess(access)

"An array of objects that define dataset access for one or more entities. Structure is documented below."

fn spec.initProvider.withAccessMixin

withAccessMixin(access)

"An array of objects that define dataset access for one or more entities. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withDefaultCollation

withDefaultCollation(defaultCollation)

"Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported:"

fn spec.initProvider.withDefaultEncryptionConfiguration

withDefaultEncryptionConfiguration(defaultEncryptionConfiguration)

"The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below."

fn spec.initProvider.withDefaultEncryptionConfigurationMixin

withDefaultEncryptionConfigurationMixin(defaultEncryptionConfiguration)

"The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.withDefaultPartitionExpirationMs

withDefaultPartitionExpirationMs(defaultPartitionExpirationMs)

"The default partition expiration for all partitioned tables in the dataset, in milliseconds."

fn spec.initProvider.withDefaultTableExpirationMs

withDefaultTableExpirationMs(defaultTableExpirationMs)

"The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour)."

fn spec.initProvider.withDeleteContentsOnDestroy

withDeleteContentsOnDestroy(deleteContentsOnDestroy)

"If set to true, delete all the tables in the dataset when destroying the resource; otherwise, destroying the resource will fail if tables are present."

fn spec.initProvider.withDescription

withDescription(description)

"A user-friendly description of the dataset"

fn spec.initProvider.withFriendlyName

withFriendlyName(friendlyName)

"A descriptive name for the dataset"

fn spec.initProvider.withIsCaseInsensitive

withIsCaseInsensitive(isCaseInsensitive)

"TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references."

fn spec.initProvider.withLabels

withLabels(labels)

"The labels associated with this dataset. You can use these to organize and group your datasets"

fn spec.initProvider.withLabelsMixin

withLabelsMixin(labels)

"The labels associated with this dataset. You can use these to organize and group your datasets"

Note: This function appends passed data to existing values

fn spec.initProvider.withLocation

withLocation(location)

"The geographic location where the dataset should reside. See official docs."

fn spec.initProvider.withMaxTimeTravelHours

withMaxTimeTravelHours(maxTimeTravelHours)

"Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days)."

obj spec.initProvider.access

"An array of objects that define dataset access for one or more entities. Structure is documented below."

fn spec.initProvider.access.withDataset

withDataset(dataset)

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

fn spec.initProvider.access.withDatasetMixin

withDatasetMixin(dataset)

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.access.withDomain

withDomain(domain)

"A domain to grant access to. Any users signed in with the domain specified will be granted the specified access"

fn spec.initProvider.access.withGroupByEmail

withGroupByEmail(groupByEmail)

"An email address of a Google Group to grant access to."

fn spec.initProvider.access.withRole

withRole(role)

"Describes the rights granted to the user specified by the other member of the access object. Basic, predefined, and custom roles are supported. Predefined roles that have equivalent basic roles are swapped by the API to their basic counterparts. See official docs."

fn spec.initProvider.access.withRoutine

withRoutine(routine)

"A routine from a different dataset to grant access to. Queries executed against that routine will have read access to tables in this dataset. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. Structure is documented below."

fn spec.initProvider.access.withRoutineMixin

withRoutineMixin(routine)

"A routine from a different dataset to grant access to. Queries executed against that routine will have read access to tables in this dataset. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.access.withSpecialGroup

withSpecialGroup(specialGroup)

"A special group to grant access to. Possible values include:"

fn spec.initProvider.access.withView

withView(view)

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

fn spec.initProvider.access.withViewMixin

withViewMixin(view)

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

Note: This function appends passed data to existing values

obj spec.initProvider.access.dataset

"Grants all resources of particular types in a particular dataset read access to the current dataset. Structure is documented below."

fn spec.initProvider.access.dataset.withDataset

withDataset(dataset)

"The dataset this entry applies to Structure is documented below."

fn spec.initProvider.access.dataset.withDatasetMixin

withDatasetMixin(dataset)

"The dataset this entry applies to Structure is documented below."

Note: This function appends passed data to existing values

fn spec.initProvider.access.dataset.withTargetTypes

withTargetTypes(targetTypes)

"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS"

fn spec.initProvider.access.dataset.withTargetTypesMixin

withTargetTypesMixin(targetTypes)

"Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS"

Note: This function appends passed data to existing values

obj spec.initProvider.access.dataset.dataset

"The dataset this entry applies to Structure is documented below."

fn spec.initProvider.access.dataset.dataset.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

obj spec.initProvider.access.view

"A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Structure is documented below."

fn spec.initProvider.access.view.withDatasetId

withDatasetId(datasetId)

"The ID of the dataset containing this table."

fn spec.initProvider.access.view.withProjectId

withProjectId(projectId)

"The ID of the project containing this table."

fn spec.initProvider.access.view.withTableId

withTableId(tableId)

"The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters."

obj spec.providerConfigRef

"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."

fn spec.providerConfigRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerConfigRef.policy

"Policies for referencing."

fn spec.providerConfigRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerConfigRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.providerRef

"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef"

fn spec.providerRef.withName

withName(name)

"Name of the referenced object."

obj spec.providerRef.policy

"Policies for referencing."

fn spec.providerRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.providerRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo

"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."

fn spec.publishConnectionDetailsTo.withName

withName(name)

"Name is the name of the connection secret."

obj spec.publishConnectionDetailsTo.configRef

"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."

fn spec.publishConnectionDetailsTo.configRef.withName

withName(name)

"Name of the referenced object."

obj spec.publishConnectionDetailsTo.configRef.policy

"Policies for referencing."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolution

withResolution(resolution)

"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."

fn spec.publishConnectionDetailsTo.configRef.policy.withResolve

withResolve(resolve)

"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."

obj spec.publishConnectionDetailsTo.metadata

"Metadata is the metadata for connection secret."

fn spec.publishConnectionDetailsTo.metadata.withAnnotations

withAnnotations(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withLabels

withLabels(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin

withLabelsMixin(labels)

"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."

Note: This function appends passed data to existing values

fn spec.publishConnectionDetailsTo.metadata.withType

withType(type)

"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."

obj spec.writeConnectionSecretToRef

"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."

fn spec.writeConnectionSecretToRef.withName

withName(name)

"Name of the secret."

fn spec.writeConnectionSecretToRef.withNamespace

withNamespace(namespace)

"Namespace of the secret."