v1beta1

package
v1.127.0 Latest Latest
Warning

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

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

Documentation

Overview

Package v1beta1 contains API Schema definitions for the bigquerydatatransfer 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/bigquerydatatransfer +k8s:defaulter-gen=TypeMeta +groupName=bigquerydatatransfer.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: "bigquerydatatransfer.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

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

Functions

This section is empty.

Types

type BigQueryDataTransferConfig 

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

	Spec   BigQueryDataTransferConfigSpec   `json:"spec,omitempty"`
	Status BigQueryDataTransferConfigStatus `json:"status,omitempty"`
}

BigQueryDataTransferConfig is the Schema for the bigquerydatatransfer API +k8s:openapi-gen=true

func (*BigQueryDataTransferConfig) DeepCopy 

func (in *BigQueryDataTransferConfig) DeepCopy() *BigQueryDataTransferConfig

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

func (*BigQueryDataTransferConfig) DeepCopyInto 

func (in *BigQueryDataTransferConfig) DeepCopyInto(out *BigQueryDataTransferConfig)

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

func (*BigQueryDataTransferConfig) DeepCopyObject 

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

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

type BigQueryDataTransferConfigList 

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

BigQueryDataTransferConfigList contains a list of BigQueryDataTransferConfig

func (*BigQueryDataTransferConfigList) DeepCopy 

func (in *BigQueryDataTransferConfigList) DeepCopy() *BigQueryDataTransferConfigList

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

func (*BigQueryDataTransferConfigList) DeepCopyInto 

func (in *BigQueryDataTransferConfigList) DeepCopyInto(out *BigQueryDataTransferConfigList)

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

func (*BigQueryDataTransferConfigList) DeepCopyObject 

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

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

type BigQueryDataTransferConfigSpec 

type BigQueryDataTransferConfigSpec struct {
	/* The number of days to look back to automatically refresh the data. For example, if `data_refresh_window_days = 10`, then every day BigQuery reingests data for [today-10, today-1], rather than ingesting data for just [today-1]. Only valid if the data source supports the feature. Set the value to 0 to use the default value. */
	// +optional
	DataRefreshWindowDays *int32 `json:"dataRefreshWindowDays,omitempty"`

	/* Immutable. Data source ID. This cannot be changed once data transfer is created. The full list of available data source IDs can be returned through an API call: https://cloud.google.com/bigquery-transfer/docs/reference/datatransfer/rest/v1/projects.locations.dataSources/list */
	DataSourceID string `json:"dataSourceID"`

	/* The BigQuery target dataset id. */
	DatasetRef v1alpha1.ResourceRef `json:"datasetRef"`

	/* Is this config disabled. When set to true, no runs will be scheduled for this transfer config. */
	// +optional
	Disabled *bool `json:"disabled,omitempty"`

	/* User specified display name for the data transfer. */
	// +optional
	DisplayName *string `json:"displayName,omitempty"`

	/* Email notifications will be sent according to these preferences to the email address of the user who owns this transfer config. */
	// +optional
	EmailPreferences *ConfigEmailPreferences `json:"emailPreferences,omitempty"`

	/* The encryption configuration part. Currently, it is only used for the optional KMS key name. The BigQuery service account of your project must be granted permissions to use the key. Read methods will return the key name applied in effect. Write methods will apply the key if it is present, or otherwise try to apply project default keys if it is absent. */
	// +optional
	EncryptionConfiguration *ConfigEncryptionConfiguration `json:"encryptionConfiguration,omitempty"`

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

	/* Parameters specific to each data source. For more information see the bq tab in the 'Setting up a data transfer' section for each data source. For example the parameters for Cloud Storage transfers are listed here: https://cloud.google.com/bigquery-transfer/docs/cloud-storage-transfer#bq */
	Params map[string]string `json:"params"`

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

	/* Pub/Sub topic where notifications will be sent after transfer runs associated with this transfer config finish. */
	// +optional
	PubSubTopicRef *v1alpha1.ResourceRef `json:"pubSubTopicRef,omitempty"`

	/* Immutable. The BigQueryDataTransferConfig name. If not given, the metadata.name will be used. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Data transfer schedule.
	If the data source does not support a custom schedule, this should be
	empty. If it is empty, the default value for the data source will be used.
	The specified times are in UTC.
	Examples of valid format:
	`1st,3rd monday of month 15:30`,
	`every wed,fri of jan,jun 13:15`, and
	`first sunday of quarter 00:00`.
	See more explanation about the format here:
	https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

	NOTE: The minimum interval time between recurring transfers depends on the
	data source; refer to the documentation for your data source. */
	// +optional
	Schedule *string `json:"schedule,omitempty"`

	/* Options customizing the data transfer schedule. */
	// +optional
	ScheduleOptions *ConfigScheduleOptions `json:"scheduleOptions,omitempty"`

	/* Service account email. If this field is set, the transfer config will be created with this service account's credentials. It requires that the requesting user calling this API has permissions to act as this service account. Note that not all data sources support service account credentials when creating a transfer config. For the latest list of data sources, please refer to https://cloud.google.com/bigquery/docs/use-service-accounts. */
	// +optional
	ServiceAccountRef *v1alpha1.ResourceRef `json:"serviceAccountRef,omitempty"`
}

func (*BigQueryDataTransferConfigSpec) DeepCopy 

func (in *BigQueryDataTransferConfigSpec) DeepCopy() *BigQueryDataTransferConfigSpec

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

func (*BigQueryDataTransferConfigSpec) DeepCopyInto 

func (in *BigQueryDataTransferConfigSpec) DeepCopyInto(out *BigQueryDataTransferConfigSpec)

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

type BigQueryDataTransferConfigStatus 

type BigQueryDataTransferConfigStatus struct {
	/* Conditions represent the latest available observations of the
	   BigQueryDataTransferConfig's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* A unique specifier for the BigQueryDataTransferConfig 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 *ConfigObservedStateStatus `json:"observedState,omitempty"`
}

func (*BigQueryDataTransferConfigStatus) DeepCopy 

func (in *BigQueryDataTransferConfigStatus) DeepCopy() *BigQueryDataTransferConfigStatus

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

func (*BigQueryDataTransferConfigStatus) DeepCopyInto 

func (in *BigQueryDataTransferConfigStatus) DeepCopyInto(out *BigQueryDataTransferConfigStatus)

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

type ConfigEmailPreferences 

type ConfigEmailPreferences struct {
	/* If true, email notifications will be sent on transfer run failures. */
	// +optional
	EnableFailureEmail *bool `json:"enableFailureEmail,omitempty"`
}

func (*ConfigEmailPreferences) DeepCopy 

func (in *ConfigEmailPreferences) DeepCopy() *ConfigEmailPreferences

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

func (*ConfigEmailPreferences) DeepCopyInto 

func (in *ConfigEmailPreferences) DeepCopyInto(out *ConfigEmailPreferences)

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

type ConfigEncryptionConfiguration 

type ConfigEncryptionConfiguration struct {
	/* The KMS key used for encrypting BigQuery data. */
	// +optional
	KmsKeyRef *v1alpha1.ResourceRef `json:"kmsKeyRef,omitempty"`
}

func (*ConfigEncryptionConfiguration) DeepCopy 

func (in *ConfigEncryptionConfiguration) DeepCopy() *ConfigEncryptionConfiguration

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

func (*ConfigEncryptionConfiguration) DeepCopyInto 

func (in *ConfigEncryptionConfiguration) DeepCopyInto(out *ConfigEncryptionConfiguration)

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

type ConfigObservedStateStatus 

type ConfigObservedStateStatus struct {
	/* Output only. Region in which BigQuery dataset is located. */
	// +optional
	DatasetRegion *string `json:"datasetRegion,omitempty"`

	/* Identifier. The resource name of the transfer config. Transfer config names have the form either `projects/{project_id}/locations/{region}/transferConfigs/{config_id}` or `projects/{project_id}/transferConfigs/{config_id}`, where `config_id` is usually a UUID, even though it is not guaranteed or required. The name is ignored when creating a transfer config. */
	// +optional
	Name *string `json:"name,omitempty"`

	/* Output only. Next time when data transfer will run. */
	// +optional
	NextRunTime *string `json:"nextRunTime,omitempty"`

	/* Output only. Information about the user whose credentials are used to transfer data. Populated only for `transferConfigs.get` requests. In case the user information is not available, this field will not be populated. */
	// +optional
	OwnerInfo *ConfigOwnerInfoStatus `json:"ownerInfo,omitempty"`

	/* Output only. State of the most recently updated transfer run. */
	// +optional
	State *string `json:"state,omitempty"`

	/* Output only. Data transfer modification time. Ignored by server on input. */
	// +optional
	UpdateTime *string `json:"updateTime,omitempty"`

	/* Deprecated. Unique ID of the user on whose behalf transfer is done. */
	// +optional
	UserID *int64 `json:"userID,omitempty"`
}

func (*ConfigObservedStateStatus) DeepCopy 

func (in *ConfigObservedStateStatus) DeepCopy() *ConfigObservedStateStatus

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

func (*ConfigObservedStateStatus) DeepCopyInto 

func (in *ConfigObservedStateStatus) DeepCopyInto(out *ConfigObservedStateStatus)

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

type ConfigOwnerInfoStatus 

type ConfigOwnerInfoStatus struct {
	/* E-mail address of the user. */
	// +optional
	Email *string `json:"email,omitempty"`
}

func (*ConfigOwnerInfoStatus) DeepCopy 

func (in *ConfigOwnerInfoStatus) DeepCopy() *ConfigOwnerInfoStatus

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

func (*ConfigOwnerInfoStatus) DeepCopyInto 

func (in *ConfigOwnerInfoStatus) DeepCopyInto(out *ConfigOwnerInfoStatus)

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

type ConfigScheduleOptions 

type ConfigScheduleOptions struct {
	/* If true, automatic scheduling of data transfer runs for this configuration will be disabled. The runs can be started on ad-hoc basis using StartManualTransferRuns API. When automatic scheduling is disabled, the TransferConfig.schedule field will be ignored. */
	// +optional
	DisableAutoScheduling *bool `json:"disableAutoScheduling,omitempty"`

	/* Defines time to stop scheduling transfer runs. A transfer run cannot be scheduled at or after the end time. The end time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option. */
	// +optional
	EndTime *string `json:"endTime,omitempty"`

	/* Specifies time to start scheduling transfer runs. The first run will be scheduled at or after the start time according to a recurrence pattern defined in the schedule string. The start time can be changed at any moment. The time when a data transfer can be triggered manually is not limited by this option. */
	// +optional
	StartTime *string `json:"startTime,omitempty"`
}

func (*ConfigScheduleOptions) DeepCopy 

func (in *ConfigScheduleOptions) DeepCopy() *ConfigScheduleOptions

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

func (*ConfigScheduleOptions) DeepCopyInto 

func (in *ConfigScheduleOptions) DeepCopyInto(out *ConfigScheduleOptions)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.