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

+kcc:proto=google.cloud.bigquery.datatransfer.v1

+kubebuilder:object:generate=true +groupName=bigquerydatatransfer.cnrm.cloud.google.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = 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: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var BigQueryDataTransferConfigGVK = GroupVersion.WithKind("BigQueryDataTransferConfig")

Functions

This section is empty.

Types

type Any added in v1.127.0 

type Any struct {
	// A URL/resource name that uniquely identifies the type of the serialized
	//  protocol buffer message. This string must contain at least
	//  one "/" character. The last segment of the URL's path must represent
	//  the fully qualified name of the type (as in
	//  `path/google.protobuf.Duration`). The name should be in a canonical form
	//  (e.g., leading "." is not accepted).
	//
	//  In practice, teams usually precompile into the binary all types that they
	//  expect it to use in the context of Any. However, for URLs which use the
	//  scheme `http`, `https`, or no scheme, one can optionally set up a type
	//  server that maps type URLs to message definitions as follows:
	//
	//  * If no scheme is provided, `https` is assumed.
	//  * An HTTP GET on the URL must yield a [google.protobuf.Type][]
	//    value in binary format, or produce an error.
	//  * Applications are allowed to cache lookup results based on the
	//    URL, or have them precompiled into a binary to avoid any
	//    lookup. Therefore, binary compatibility needs to be preserved
	//    on changes to types. (Use versioned type names to manage
	//    breaking changes.)
	//
	//  Note: this functionality is not currently available in the official
	//  protobuf release, and it is not used for type URLs beginning with
	//  type.googleapis.com.
	//
	//  Schemes other than `http`, `https` (or the empty scheme) might be
	//  used with implementation specific semantics.
	TypeURL *string `json:"typeURL,omitempty"`

	// Must be a valid serialized protocol buffer of the above specified type.
	Value []byte `json:"value,omitempty"`
}

+kcc:proto=google.protobuf.Any

func (*Any) DeepCopy added in v1.127.0 

func (in *Any) DeepCopy() *Any

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

func (*Any) DeepCopyInto added in v1.127.0 

func (in *Any) DeepCopyInto(out *Any)

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

type BigQueryDataTransferConfig 

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

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

BigQueryDataTransferConfig is the Schema for the BigQueryDataTransferConfig 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"`
}

+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object 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 BigQueryDataTransferConfigObservedState 

type BigQueryDataTransferConfigObservedState struct {
	// Output only. Region in which BigQuery dataset is located.
	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.
	Name *string `json:"name,omitempty"`

	// Output only. Next time when data transfer will run.
	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.
	OwnerInfo *UserInfo `json:"ownerInfo,omitempty"`

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

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

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

	// Output only. Error code with detailed information about reason of the
	//  latest config failure.
	Error *Status `json:"error,omitempty"`
}

BigQueryDataTransferConfigSpec defines the desired state of BigQueryDataTransferConfig +kcc:proto=google.cloud.bigquery.datatransfer.v1.TransferConfig

func (*BigQueryDataTransferConfigObservedState) DeepCopy 

func (in *BigQueryDataTransferConfigObservedState) DeepCopy() *BigQueryDataTransferConfigObservedState

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

func (*BigQueryDataTransferConfigObservedState) DeepCopyInto 

func (in *BigQueryDataTransferConfigObservedState) DeepCopyInto(out *BigQueryDataTransferConfigObservedState)

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

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.
	DataRefreshWindowDays *int32 `json:"dataRefreshWindowDays,omitempty"`

	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="DataSourceID field is immutable"
	// 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
	// +required
	DataSourceID *string `json:"dataSourceID,omitempty"`

	// The BigQuery target dataset id.
	// +required
	DatasetRef *refv1beta1.BigQueryDatasetRef `json:"datasetRef,omitempty"`

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

	// User specified display name for the data transfer.
	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.
	EmailPreferences *EmailPreferences `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.
	EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`

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

	// 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
	// +required
	Params map[string]string `json:"params,omitempty"`

	Parent `json:",inline"`

	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="ResourceID field is immutable"
	// Immutable.
	// The BigQueryDataTransferConfig name. If not given, the metadata.name will be used.
	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.
	Schedule *string `json:"schedule,omitempty"`

	// Options customizing the data transfer schedule.
	ScheduleOptions *ScheduleOptions `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.
	ServiceAccountRef *refv1beta1.IAMServiceAccountRef `json:"serviceAccountRef,omitempty"`

	// V2 options customizing different types of data transfer schedule.
	//  This field supports existing time-based and manual transfer schedule. Also
	//  supports Event-Driven transfer schedule. ScheduleOptionsV2 cannot be used
	//  together with ScheduleOptions/Schedule.
	ScheduleOptionsV2 *ScheduleOptionsV2 `json:"scheduleOptionsV2,omitempty"`
}

BigQueryDataTransferConfigSpec defines the desired state of BigQueryDataTransferConfig +kcc:proto=google.cloud.bigquery.datatransfer.v1.TransferConfig

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
	   object's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,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.
	ObservedGeneration *int64 `json:"observedGeneration,omitempty"`

	// A unique specifier for the BigQueryDataTransferConfig resource in GCP.
	ExternalRef *string `json:"externalRef,omitempty"`

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

BigQueryDataTransferConfigStatus defines the config connector machine state of BigQueryDataTransferConfig

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 EmailPreferences 

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

+kcc:proto=google.cloud.bigquery.datatransfer.v1.EmailPreferences

func (*EmailPreferences) DeepCopy 

func (in *EmailPreferences) DeepCopy() *EmailPreferences

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

func (*EmailPreferences) DeepCopyInto 

func (in *EmailPreferences) DeepCopyInto(out *EmailPreferences)

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

type EncryptionConfiguration 

type EncryptionConfiguration struct {
	// The KMS key used for encrypting BigQuery data.
	KmsKeyRef *refv1beta1.KMSCryptoKeyRef `json:"kmsKeyRef,omitempty"`
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.EncryptionConfiguration

func (*EncryptionConfiguration) DeepCopy 

func (in *EncryptionConfiguration) DeepCopy() *EncryptionConfiguration

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

func (*EncryptionConfiguration) DeepCopyInto 

func (in *EncryptionConfiguration) DeepCopyInto(out *EncryptionConfiguration)

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

type EventDrivenSchedule added in v1.127.0 

type EventDrivenSchedule struct {
	// Pub/Sub subscription used to receive events.
	//  Only Google Cloud Storage data source support this option.
	PubSubSubscriptionRef *refv1beta1.PubSubSubscriptionRef `json:"pubSubSubscriptionRef,omitempty"`
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.EventDrivenSchedule

func (*EventDrivenSchedule) DeepCopy added in v1.127.0 

func (in *EventDrivenSchedule) DeepCopy() *EventDrivenSchedule

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

func (*EventDrivenSchedule) DeepCopyInto added in v1.127.0 

func (in *EventDrivenSchedule) DeepCopyInto(out *EventDrivenSchedule)

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

type ManualSchedule added in v1.127.0 

type ManualSchedule struct {
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.ManualSchedule

func (*ManualSchedule) DeepCopy added in v1.127.0 

func (in *ManualSchedule) DeepCopy() *ManualSchedule

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

func (*ManualSchedule) DeepCopyInto added in v1.127.0 

func (in *ManualSchedule) DeepCopyInto(out *ManualSchedule)

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

type Parent 

type Parent struct {
	// +required
	ProjectRef *refv1beta1.ProjectRef `json:"projectRef"`

	// +kubebuilder:validation:XValidation:rule="self == oldSelf",message="Location field is immutable"
	// Immutable.
	// +required
	Location string `json:"location"`
}

func (*Parent) DeepCopy 

func (in *Parent) DeepCopy() *Parent

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

func (*Parent) DeepCopyInto 

func (in *Parent) DeepCopyInto(out *Parent)

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

type ScheduleOptions 

type ScheduleOptions 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.
	DisableAutoScheduling *bool `json:"disableAutoScheduling,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.
	StartTime *string `json:"startTime,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.
	EndTime *string `json:"endTime,omitempty"`
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.ScheduleOptions

func (*ScheduleOptions) DeepCopy 

func (in *ScheduleOptions) DeepCopy() *ScheduleOptions

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

func (*ScheduleOptions) DeepCopyInto 

func (in *ScheduleOptions) DeepCopyInto(out *ScheduleOptions)

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

type ScheduleOptionsV2 added in v1.127.0 

type ScheduleOptionsV2 struct {
	// Time based transfer schedule options. This is the default schedule
	//  option.
	TimeBasedSchedule *TimeBasedSchedule `json:"timeBasedSchedule,omitempty"`

	// Manual transfer schedule. If set, the transfer run will not be
	//  auto-scheduled by the system, unless the client invokes
	//  StartManualTransferRuns.  This is equivalent to
	//  disable_auto_scheduling = true.
	ManualSchedule *ManualSchedule `json:"manualSchedule,omitempty"`

	// Event driven transfer schedule options. If set, the transfer will be
	//  scheduled upon events arrial.
	EventDrivenSchedule *EventDrivenSchedule `json:"eventDrivenSchedule,omitempty"`
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.ScheduleOptionsV2

func (*ScheduleOptionsV2) DeepCopy added in v1.127.0 

func (in *ScheduleOptionsV2) DeepCopy() *ScheduleOptionsV2

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

func (*ScheduleOptionsV2) DeepCopyInto added in v1.127.0 

func (in *ScheduleOptionsV2) DeepCopyInto(out *ScheduleOptionsV2)

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

type Status added in v1.127.0 

type Status struct {
	// The status code, which should be an enum value of
	//  [google.rpc.Code][google.rpc.Code].
	Code *int32 `json:"code,omitempty"`

	// A developer-facing error message, which should be in English. Any
	//  user-facing error message should be localized and sent in the
	//  [google.rpc.Status.details][google.rpc.Status.details] field, or localized
	//  by the client.
	Message *string `json:"message,omitempty"`
}

+kcc:proto=google.rpc.Status

func (*Status) DeepCopy added in v1.127.0 

func (in *Status) DeepCopy() *Status

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

func (*Status) DeepCopyInto added in v1.127.0 

func (in *Status) DeepCopyInto(out *Status)

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

type TimeBasedSchedule added in v1.127.0 

type TimeBasedSchedule struct {
	// 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.
	Schedule *string `json:"schedule,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.
	StartTime *string `json:"startTime,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.
	EndTime *string `json:"endTime,omitempty"`
}

+kcc:proto=google.cloud.bigquery.datatransfer.v1.TimeBasedSchedule

func (*TimeBasedSchedule) DeepCopy added in v1.127.0 

func (in *TimeBasedSchedule) DeepCopy() *TimeBasedSchedule

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

func (*TimeBasedSchedule) DeepCopyInto added in v1.127.0 

func (in *TimeBasedSchedule) DeepCopyInto(out *TimeBasedSchedule)

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

type UserInfo 

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

+kcc:proto=google.cloud.bigquery.datatransfer.v1.UserInfo

func (*UserInfo) DeepCopy 

func (in *UserInfo) DeepCopy() *UserInfo

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

func (*UserInfo) DeepCopyInto 

func (in *UserInfo) DeepCopyInto(out *UserInfo)

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.