Skip to content

bigqueryconnection.v1alpha1.bigQueryConnectionConnection

"BigQueryConnectionConnection is the Schema for the BigQueryConnectionConnection API"

Index

Fields

fn new

new(name)

new returns an instance of BigQueryConnectionConnection

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

"BigQueryConnectionConnectionSpec defines the desired state to connect BigQuery to external resources"

fn spec.withCloudResource

withCloudResource(cloudResource)

"Use Cloud Resource properties."

fn spec.withCloudResourceMixin

withCloudResourceMixin(cloudResource)

"Use Cloud Resource properties."

Note: This function appends passed data to existing values

fn spec.withDescription

withDescription(description)

"User provided description."

fn spec.withFriendlyName

withFriendlyName(friendlyName)

"User provided display name for the connection."

fn spec.withLocation

withLocation(location)

"Immutable."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The BigQuery Connection ID used for resource creation or acquisition. For creation: If specified, this value is used as the connection ID. If not provided, a UUID will be generated and assigned as the connection ID. For acquisition: This field must be provided to identify the connection resource to acquire."

obj spec.aws

"Amazon Web Services (AWS) properties."

obj spec.aws.accessRole

"Authentication using Google owned service account to assume into customer's AWS IAM Role."

fn spec.aws.accessRole.withIamRoleID

withIamRoleID(iamRoleID)

"The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection."

obj spec.azure

"Azure properties."

fn spec.azure.withCustomerTenantID

withCustomerTenantID(customerTenantID)

"The id of customer's directory that host the data."

fn spec.azure.withFederatedApplicationClientID

withFederatedApplicationClientID(federatedApplicationClientID)

"The client ID of the user's Azure Active Directory Application used for a federated connection."

obj spec.cloudSQL

"Cloud SQL properties."

fn spec.cloudSQL.withType

withType(type)

"Type of the Cloud SQL database."

obj spec.cloudSQL.credential

"Cloud SQL credential."

obj spec.cloudSQL.credential.secretRef

"The Kubernetes Secret object that stores the \"username\" and \"password\" information. The Secret type has to be kubernetes.io/basic-auth."

fn spec.cloudSQL.credential.secretRef.withName

withName(name)

"The metadata.name field of a Kubernetes Secret"

fn spec.cloudSQL.credential.secretRef.withNamespace

withNamespace(namespace)

"The metadata.namespace field of a Kubernetes Secret."

obj spec.cloudSQL.databaseRef

"Reference to the SQL Database."

fn spec.cloudSQL.databaseRef.withExternal

withExternal(external)

"The SQL Database name, when not managed by Config Connector."

fn spec.cloudSQL.databaseRef.withName

withName(name)

"The name field of a SQLDatabase resource."

fn spec.cloudSQL.databaseRef.withNamespace

withNamespace(namespace)

"The namespace field of a SQLDatabase resource."

obj spec.cloudSQL.instanceRef

"Reference to the Cloud SQL instance ID."

fn spec.cloudSQL.instanceRef.withExternal

withExternal(external)

"The SQLInstance selfLink, when not managed by Config Connector."

fn spec.cloudSQL.instanceRef.withName

withName(name)

"The name field of a SQLInstance resource."

fn spec.cloudSQL.instanceRef.withNamespace

withNamespace(namespace)

"The namespace field of a SQLInstance resource."

obj spec.cloudSpanner

"Cloud Spanner properties."

fn spec.cloudSpanner.withDatabaseRole

withDatabaseRole(databaseRole)

"Optional. Cloud Spanner database role for fine-grained access control.\n The Cloud Spanner admin should have provisioned the database role with\n appropriate permissions, such as SELECT and INSERT. Other users should\n only use roles provided by their Cloud Spanner admins.\n\n For more details, see [About fine-grained access control]\n (https://cloud.google.com/spanner/docs/fgac-about).\n\n REQUIRES: The database role name must start with a letter, and can only\n contain letters, numbers, and underscores."

fn spec.cloudSpanner.withMaxParallelism

withMaxParallelism(maxParallelism)

"Allows setting max parallelism per query when executing on Spanner\n independent compute resources. If unspecified, default values of\n parallelism are chosen that are dependent on the Cloud Spanner instance\n configuration.\n\n REQUIRES: use_parallelism must be set.\n REQUIRES: Either use_data_boost or use_serverless_analytics must be\n set."

fn spec.cloudSpanner.withUseDataBoost

withUseDataBoost(useDataBoost)

"If set, the request will be executed via Spanner independent compute\n resources.\n REQUIRES: use_parallelism must be set.\n\n NOTE: use_serverless_analytics will be deprecated. Prefer\n use_data_boost over use_serverless_analytics."

fn spec.cloudSpanner.withUseParallelism

withUseParallelism(useParallelism)

"If parallelism should be used when reading from Cloud Spanner"

fn spec.cloudSpanner.withUseServerlessAnalytics

withUseServerlessAnalytics(useServerlessAnalytics)

"If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics."

obj spec.cloudSpanner.databaseRef

"Reference to a spanner database ID."

fn spec.cloudSpanner.databaseRef.withExternal

withExternal(external)

"The Spanner Database selfLink, when not managed by Config Connector."

fn spec.cloudSpanner.databaseRef.withName

withName(name)

"The name field of a SpannerDatabase resource."

fn spec.cloudSpanner.databaseRef.withNamespace

withNamespace(namespace)

"The namespace field of a SpannerDatabase resource."

obj spec.projectRef

"The Project that this resource belongs to."

fn spec.projectRef.withExternal

withExternal(external)

"The projectID field of a project, when not managed by Config Connector."

fn spec.projectRef.withKind

withKind(kind)

"The kind of the Project resource; optional but must be Project if provided."

fn spec.projectRef.withName

withName(name)

"The name field of a Project resource."

fn spec.projectRef.withNamespace

withNamespace(namespace)

"The namespace field of a Project resource."

obj spec.spark

"Spark properties."

obj spec.spark.metastoreService

"Optional. Dataproc Metastore Service configuration for the connection."

obj spec.spark.metastoreService.metastoreServiceRef

"Optional. Resource name of an existing Dataproc Metastore service.\n\n Example:\n\n * projects/[project_id]/locations/[region]/services/[service_id]"

fn spec.spark.metastoreService.metastoreServiceRef.withExternal

withExternal(external)

"The self-link of an existing Dataproc Metastore service , when not managed by Config Connector."

obj spec.spark.sparkHistoryServer

"Optional. Spark History Server configuration for the connection."

obj spec.spark.sparkHistoryServer.dataprocClusterRef

"Optional. Resource name of an existing Dataproc Cluster to act as a Spark\n History Server for the connection.\n\n Example:\n\n * projects/[project_id]/regions/[region]/clusters/[cluster_name]"

fn spec.spark.sparkHistoryServer.dataprocClusterRef.withExternal

withExternal(external)

"The self-link of an existing Dataproc Cluster to act as a Spark History Server for the connection , when not managed by Config Connector."

fn spec.spark.sparkHistoryServer.dataprocClusterRef.withName

withName(name)

"The name field of a Dataproc Cluster."

fn spec.spark.sparkHistoryServer.dataprocClusterRef.withNamespace

withNamespace(namespace)

"The namespace field of a Dataproc Cluster."