v1beta1

package
v1.125.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1beta1 contains API Schema definitions for the bigqueryconnection v1beta1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/bigqueryconnection +k8s:defaulter-gen=TypeMeta +groupName=bigqueryconnection.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source
var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "bigqueryconnection.cnrm.cloud.google.com", Version: "v1beta1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme is a global function that registers this API group & version to a scheme
	AddToScheme = SchemeBuilder.AddToScheme

	BigQueryConnectionConnectionGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(BigQueryConnectionConnection{}).Name(),
	}
)

Functions

This section is empty.

Types

type BigQueryConnectionConnection

type BigQueryConnectionConnection struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   BigQueryConnectionConnectionSpec   `json:"spec,omitempty"`
	Status BigQueryConnectionConnectionStatus `json:"status,omitempty"`
}

BigQueryConnectionConnection is the Schema for the bigqueryconnection API +k8s:openapi-gen=true

func (*BigQueryConnectionConnection) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BigQueryConnectionConnection.

func (*BigQueryConnectionConnection) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BigQueryConnectionConnection) DeepCopyObject

func (in *BigQueryConnectionConnection) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BigQueryConnectionConnectionList

type BigQueryConnectionConnectionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []BigQueryConnectionConnection `json:"items"`
}

BigQueryConnectionConnectionList contains a list of BigQueryConnectionConnection

func (*BigQueryConnectionConnectionList) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BigQueryConnectionConnectionList.

func (*BigQueryConnectionConnectionList) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*BigQueryConnectionConnectionList) DeepCopyObject

func (in *BigQueryConnectionConnectionList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type BigQueryConnectionConnectionSpec

type BigQueryConnectionConnectionSpec struct {
	/* Amazon Web Services (AWS) properties. */
	// +optional
	Aws *ConnectionAws `json:"aws,omitempty"`

	/* Azure properties. */
	// +optional
	Azure *ConnectionAzure `json:"azure,omitempty"`

	/* Use Cloud Resource properties. */
	// +optional
	CloudResource *ConnectionCloudResource `json:"cloudResource,omitempty"`

	/* Cloud SQL properties. */
	// +optional
	CloudSQL *ConnectionCloudSQL `json:"cloudSQL,omitempty"`

	/* Cloud Spanner properties. */
	// +optional
	CloudSpanner *ConnectionCloudSpanner `json:"cloudSpanner,omitempty"`

	/* User provided description. */
	// +optional
	Description *string `json:"description,omitempty"`

	/* User provided display name for the connection. */
	// +optional
	FriendlyName *string `json:"friendlyName,omitempty"`

	/* Immutable. */
	Location string `json:"location"`

	/* The Project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* 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. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Spark properties. */
	// +optional
	Spark *ConnectionSpark `json:"spark,omitempty"`
}

func (*BigQueryConnectionConnectionSpec) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BigQueryConnectionConnectionSpec.

func (*BigQueryConnectionConnectionSpec) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type BigQueryConnectionConnectionStatus

type BigQueryConnectionConnectionStatus struct {
	/* Conditions represent the latest available observations of the
	   BigQueryConnectionConnection's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* A unique specifier for the BigQueryConnectionConnection resource in GCP. */
	// +optional
	ExternalRef *string `json:"externalRef,omitempty"`

	/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
	// +optional
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	/* ObservedState is the state of the resource as most recently observed in GCP. */
	// +optional
	ObservedState *ConnectionObservedStateStatus `json:"observedState,omitempty"`
}

func (*BigQueryConnectionConnectionStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BigQueryConnectionConnectionStatus.

func (*BigQueryConnectionConnectionStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAccessRole

type ConnectionAccessRole struct {
	/* The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. */
	IamRoleID string `json:"iamRoleID"`
}

func (*ConnectionAccessRole) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAccessRole.

func (*ConnectionAccessRole) DeepCopyInto

func (in *ConnectionAccessRole) DeepCopyInto(out *ConnectionAccessRole)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAccessRoleStatus

type ConnectionAccessRoleStatus struct {
	/* A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. */
	// +optional
	Identity *string `json:"identity,omitempty"`
}

func (*ConnectionAccessRoleStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAccessRoleStatus.

func (*ConnectionAccessRoleStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAws

type ConnectionAws struct {
	/* Authentication using Google owned service account to assume into customer's AWS IAM Role. */
	AccessRole ConnectionAccessRole `json:"accessRole"`
}

func (*ConnectionAws) DeepCopy

func (in *ConnectionAws) DeepCopy() *ConnectionAws

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAws.

func (*ConnectionAws) DeepCopyInto

func (in *ConnectionAws) DeepCopyInto(out *ConnectionAws)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAwsStatus

type ConnectionAwsStatus struct {
	// +optional
	AccessRole *ConnectionAccessRoleStatus `json:"accessRole,omitempty"`
}

func (*ConnectionAwsStatus) DeepCopy

func (in *ConnectionAwsStatus) DeepCopy() *ConnectionAwsStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAwsStatus.

func (*ConnectionAwsStatus) DeepCopyInto

func (in *ConnectionAwsStatus) DeepCopyInto(out *ConnectionAwsStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAzure

type ConnectionAzure struct {
	/* The id of customer's directory that host the data. */
	CustomerTenantID string `json:"customerTenantID"`

	/* The client ID of the user's Azure Active Directory Application used for a federated connection. */
	// +optional
	FederatedApplicationClientID *string `json:"federatedApplicationClientID,omitempty"`
}

func (*ConnectionAzure) DeepCopy

func (in *ConnectionAzure) DeepCopy() *ConnectionAzure

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAzure.

func (*ConnectionAzure) DeepCopyInto

func (in *ConnectionAzure) DeepCopyInto(out *ConnectionAzure)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionAzureStatus

type ConnectionAzureStatus struct {
	/* The name of the Azure Active Directory Application. */
	// +optional
	Application *string `json:"application,omitempty"`

	/* The client id of the Azure Active Directory Application. */
	// +optional
	ClientID *string `json:"clientID,omitempty"`

	/* A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. */
	// +optional
	Identity *string `json:"identity,omitempty"`

	/* The object id of the Azure Active Directory Application. */
	// +optional
	ObjectID *string `json:"objectID,omitempty"`

	/* The URL user will be redirected to after granting consent during connection setup. */
	// +optional
	RedirectUri *string `json:"redirectUri,omitempty"`
}

func (*ConnectionAzureStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionAzureStatus.

func (*ConnectionAzureStatus) DeepCopyInto

func (in *ConnectionAzureStatus) DeepCopyInto(out *ConnectionAzureStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCloudResource

type ConnectionCloudResource struct {
}

func (*ConnectionCloudResource) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCloudResource.

func (*ConnectionCloudResource) DeepCopyInto

func (in *ConnectionCloudResource) DeepCopyInto(out *ConnectionCloudResource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCloudResourceStatus

type ConnectionCloudResourceStatus struct {
	/* The account ID of the service created for the purpose of this
	connection.

	The service account does not have any permissions associated with it
	when it is created. After creation, customers delegate permissions
	to the service account. When the connection is used in the context of an
	operation in BigQuery, the service account will be used to connect to the
	desired resources in GCP.

	The account ID is in the form of:
	<service-1234>@gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com */
	// +optional
	ServiceAccountID *string `json:"serviceAccountID,omitempty"`
}

func (*ConnectionCloudResourceStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCloudResourceStatus.

func (*ConnectionCloudResourceStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCloudSQL

type ConnectionCloudSQL struct {
	/* Cloud SQL credential. */
	Credential ConnectionCredential `json:"credential"`

	/* Reference to the SQL Database. */
	DatabaseRef v1alpha1.ResourceRef `json:"databaseRef"`

	/* Reference to the Cloud SQL instance ID. */
	InstanceRef v1alpha1.ResourceRef `json:"instanceRef"`

	/* Type of the Cloud SQL database. */
	Type string `json:"type"`
}

func (*ConnectionCloudSQL) DeepCopy

func (in *ConnectionCloudSQL) DeepCopy() *ConnectionCloudSQL

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCloudSQL.

func (*ConnectionCloudSQL) DeepCopyInto

func (in *ConnectionCloudSQL) DeepCopyInto(out *ConnectionCloudSQL)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCloudSQLStatus

type ConnectionCloudSQLStatus struct {
	/* The account ID of the service used for the purpose of this connection.

	When the connection is used in the context of an operation in
	BigQuery, this service account will serve as the identity being used for
	connecting to the CloudSQL instance specified in this connection. */
	// +optional
	ServiceAccountID *string `json:"serviceAccountID,omitempty"`
}

func (*ConnectionCloudSQLStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCloudSQLStatus.

func (*ConnectionCloudSQLStatus) DeepCopyInto

func (in *ConnectionCloudSQLStatus) DeepCopyInto(out *ConnectionCloudSQLStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCloudSpanner

type ConnectionCloudSpanner struct {
	/* Reference to a spanner database ID. */
	DatabaseRef v1alpha1.ResourceRef `json:"databaseRef"`

	/* Optional. Cloud Spanner database role for fine-grained access control.
	The Cloud Spanner admin should have provisioned the database role with
	appropriate permissions, such as `SELECT` and `INSERT`. Other users should
	only use roles provided by their Cloud Spanner admins.

	For more details, see [About fine-grained access control]
	(https://cloud.google.com/spanner/docs/fgac-about).

	REQUIRES: The database role name must start with a letter, and can only
	contain letters, numbers, and underscores. */
	// +optional
	DatabaseRole *string `json:"databaseRole,omitempty"`

	/* Allows setting max parallelism per query when executing on Spanner
	independent compute resources. If unspecified, default values of
	parallelism are chosen that are dependent on the Cloud Spanner instance
	configuration.

	REQUIRES: `use_parallelism` must be set.
	REQUIRES: Either `use_data_boost` or `use_serverless_analytics` must be
	set. */
	// +optional
	MaxParallelism *int32 `json:"maxParallelism,omitempty"`

	/* If set, the request will be executed via Spanner independent compute
	resources.
	REQUIRES: `use_parallelism` must be set.

	NOTE: `use_serverless_analytics` will be deprecated. Prefer
	`use_data_boost` over `use_serverless_analytics`. */
	// +optional
	UseDataBoost *bool `json:"useDataBoost,omitempty"`

	/* If parallelism should be used when reading from Cloud Spanner */
	// +optional
	UseParallelism *bool `json:"useParallelism,omitempty"`

	/* If the serverless analytics service should be used to read data from Cloud Spanner. Note: `use_parallelism` must be set when using serverless analytics. */
	// +optional
	UseServerlessAnalytics *bool `json:"useServerlessAnalytics,omitempty"`
}

func (*ConnectionCloudSpanner) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCloudSpanner.

func (*ConnectionCloudSpanner) DeepCopyInto

func (in *ConnectionCloudSpanner) DeepCopyInto(out *ConnectionCloudSpanner)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionCredential

type ConnectionCredential struct {
	/* The Kubernetes Secret object that stores the "username" and "password" information. The Secret type has to be `kubernetes.io/basic-auth`. */
	// +optional
	SecretRef *v1alpha1.ResourceRef `json:"secretRef,omitempty"`
}

func (*ConnectionCredential) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionCredential.

func (*ConnectionCredential) DeepCopyInto

func (in *ConnectionCredential) DeepCopyInto(out *ConnectionCredential)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionMetastoreService

type ConnectionMetastoreService struct {
	/* Optional. Resource name of an existing Dataproc Metastore service.

	Example:

	* `projects/[project_id]/locations/[region]/services/[service_id]` */
	// +optional
	MetastoreServiceRef *v1alpha1.ResourceRef `json:"metastoreServiceRef,omitempty"`
}

func (*ConnectionMetastoreService) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionMetastoreService.

func (*ConnectionMetastoreService) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionObservedStateStatus

type ConnectionObservedStateStatus struct {
	// +optional
	Aws *ConnectionAwsStatus `json:"aws,omitempty"`

	// +optional
	Azure *ConnectionAzureStatus `json:"azure,omitempty"`

	// +optional
	CloudResource *ConnectionCloudResourceStatus `json:"cloudResource,omitempty"`

	// +optional
	CloudSQL *ConnectionCloudSQLStatus `json:"cloudSQL,omitempty"`

	/* The description for the connection. */
	// +optional
	Description *string `json:"description,omitempty"`

	/* The display name for the connection. */
	// +optional
	FriendlyName *string `json:"friendlyName,omitempty"`

	/* Output only. True, if credential is configured for this connection. */
	// +optional
	HasCredential *bool `json:"hasCredential,omitempty"`

	// +optional
	Spark *ConnectionSparkStatus `json:"spark,omitempty"`
}

func (*ConnectionObservedStateStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionObservedStateStatus.

func (*ConnectionObservedStateStatus) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionSpark

type ConnectionSpark struct {
	/* Optional. Dataproc Metastore Service configuration for the connection. */
	// +optional
	MetastoreService *ConnectionMetastoreService `json:"metastoreService,omitempty"`

	/* Optional. Spark History Server configuration for the connection. */
	// +optional
	SparkHistoryServer *ConnectionSparkHistoryServer `json:"sparkHistoryServer,omitempty"`
}

func (*ConnectionSpark) DeepCopy

func (in *ConnectionSpark) DeepCopy() *ConnectionSpark

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionSpark.

func (*ConnectionSpark) DeepCopyInto

func (in *ConnectionSpark) DeepCopyInto(out *ConnectionSpark)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionSparkHistoryServer

type ConnectionSparkHistoryServer struct {
	/* Optional. Resource name of an existing Dataproc Cluster to act as a Spark
	History Server for the connection.

	Example:

	* `projects/[project_id]/regions/[region]/clusters/[cluster_name]` */
	// +optional
	DataprocClusterRef *v1alpha1.ResourceRef `json:"dataprocClusterRef,omitempty"`
}

func (*ConnectionSparkHistoryServer) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionSparkHistoryServer.

func (*ConnectionSparkHistoryServer) DeepCopyInto

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConnectionSparkStatus

type ConnectionSparkStatus struct {
	/* The account ID of the service created for the purpose of this
	connection.

	The service account does not have any permissions associated with it when
	it is created. After creation, customers delegate permissions to the
	service account. When the connection is used in the context of a stored
	procedure for Apache Spark in BigQuery, the service account is used to
	connect to the desired resources in Google Cloud.

	The account ID is in the form of:
	bqcx-<projectnumber>-<uniqueid>@gcp-sa-bigquery-consp.iam.gserviceaccount.com */
	// +optional
	ServiceAccountID *string `json:"serviceAccountID,omitempty"`
}

func (*ConnectionSparkStatus) DeepCopy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ConnectionSparkStatus.

func (*ConnectionSparkStatus) DeepCopyInto

func (in *ConnectionSparkStatus) DeepCopyInto(out *ConnectionSparkStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL