v1alpha1

package
v1.117.0 Latest Latest
Warning

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

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

Documentation

Overview

Generate deepcopy object for bigquerydatatransfer/v1alpha1 API group

Package v1alpha1 contains API Schema definitions for the bigquerydatatransfer v1alpha1 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: "v1alpha1"}

	// 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

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

func (*BigQueryDataTransferConfig) DeepCopyInto

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

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

func (*BigQueryDataTransferConfigList) DeepCopyInto

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 dataRefreshWindowDays = 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 *int64 `json:"dataRefreshWindowDays,omitempty"`

	/* Immutable. The data source id. Cannot be changed once the transfer config is created. */
	DataSourceId string `json:"dataSourceId"`

	/* The BigQuery target dataset id. */
	// +optional
	DestinationDatasetId *string `json:"destinationDatasetId,omitempty"`

	/* When set to true, no runs are scheduled for a given transfer. */
	// +optional
	Disabled *bool `json:"disabled,omitempty"`

	/* The user specified display name for the transfer config. */
	DisplayName string `json:"displayName"`

	/* 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"`

	/* Immutable. The geographic location where the transfer config should reside.
	Examples: US, EU, asia-northeast1. The default value is US. */
	// +optional
	Location *string `json:"location,omitempty"`

	/* Pub/Sub topic where notifications will be sent after transfer runs
	associated with this transfer config finish. */
	// +optional
	NotificationPubsubTopic *string `json:"notificationPubsubTopic,omitempty"`

	Params map[string]string `json:"params"`

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

	/* Immutable. Optional. The service-generated name of the resource. Used for acquisition only. Leave unset to create a new resource. */
	// +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 granularity should be at least 8 hours, or less frequent. */
	// +optional
	Schedule *string `json:"schedule,omitempty"`

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

	/* Different parameters are configured primarily using the the 'params' field on this
	resource. This block contains the parameters which contain secrets or passwords so that they can be marked
	sensitive and hidden from plan output. The name of the field, eg: secret_access_key, will be the key
	in the 'params' map in the api request.

	Credentials may not be specified in both locations and will cause an error. Changing from one location
	to a different credential configuration in the config will require an apply to update state. */
	// +optional
	SensitiveParams *ConfigSensitiveParams `json:"sensitiveParams,omitempty"`

	/* Service account email. If this field is set, transfer config will
	be created with this service account credentials. It requires that
	requesting user calling this API has permissions to act as this service account. */
	// +optional
	ServiceAccountName *string `json:"serviceAccountName,omitempty"`
}

func (*BigQueryDataTransferConfigSpec) DeepCopy

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

func (*BigQueryDataTransferConfigSpec) DeepCopyInto

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"`
	/* The resource name of the transfer config. Transfer config names have the
	form projects/{projectId}/locations/{location}/transferConfigs/{configId}
	or projects/{projectId}/transferConfigs/{configId},
	where configId is usually a uuid, but this is not required.
	The name is ignored when creating a transfer config. */
	// +optional
	Name *string `json:"name,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"`
}

func (*BigQueryDataTransferConfigStatus) DeepCopy

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

func (*BigQueryDataTransferConfigStatus) DeepCopyInto

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. */
	EnableFailureEmail bool `json:"enableFailureEmail"`
}

func (*ConfigEmailPreferences) DeepCopy

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 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 transferConfigs.startManualRuns 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

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.

type ConfigSecretAccessKey

type ConfigSecretAccessKey struct {
	/* Value of the field. Cannot be used if 'valueFrom' is specified. */
	// +optional
	Value *string `json:"value,omitempty"`

	/* Source for the field's value. Cannot be used if 'value' is specified. */
	// +optional
	ValueFrom *ConfigValueFrom `json:"valueFrom,omitempty"`
}

func (*ConfigSecretAccessKey) DeepCopy

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

func (*ConfigSecretAccessKey) DeepCopyInto

func (in *ConfigSecretAccessKey) DeepCopyInto(out *ConfigSecretAccessKey)

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

type ConfigSensitiveParams

type ConfigSensitiveParams struct {
	/* The Secret Access Key of the AWS account transferring data from. */
	SecretAccessKey ConfigSecretAccessKey `json:"secretAccessKey"`
}

func (*ConfigSensitiveParams) DeepCopy

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

func (*ConfigSensitiveParams) DeepCopyInto

func (in *ConfigSensitiveParams) DeepCopyInto(out *ConfigSensitiveParams)

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

type ConfigValueFrom

type ConfigValueFrom struct {
	/* Reference to a value with the given key in the given Secret in the resource's namespace. */
	// +optional
	SecretKeyRef *v1alpha1.SecretKeyRef `json:"secretKeyRef,omitempty"`
}

func (*ConfigValueFrom) DeepCopy

func (in *ConfigValueFrom) DeepCopy() *ConfigValueFrom

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

func (*ConfigValueFrom) DeepCopyInto

func (in *ConfigValueFrom) DeepCopyInto(out *ConfigValueFrom)

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