v1beta1

Documentation

Overview

Package v1beta1 contains API Schema definitions for the gcp-contrib v1beta1 API group +kubebuilder:object:generate=true +groupName=gcp-contrib.alleypinapis.com

Index

• Variables
• type AppEngineHttpTarget
  • func (in *AppEngineHttpTarget) DeepCopy() *AppEngineHttpTarget
  • func (in *AppEngineHttpTarget) DeepCopyInto(out *AppEngineHttpTarget)
• type HttpTarget
  • func (in *HttpTarget) DeepCopy() *HttpTarget
  • func (in *HttpTarget) DeepCopyInto(out *HttpTarget)
• type PubsubTarget
  • func (in *PubsubTarget) DeepCopy() *PubsubTarget
  • func (in *PubsubTarget) DeepCopyInto(out *PubsubTarget)
• type RetryConfig
  • func (in *RetryConfig) DeepCopy() *RetryConfig
  • func (in *RetryConfig) DeepCopyInto(out *RetryConfig)
• type Scheduler
  • func (in *Scheduler) DeepCopy() *Scheduler
  • func (in *Scheduler) DeepCopyInto(out *Scheduler)
  • func (in *Scheduler) DeepCopyObject() runtime.Object
• type SchedulerList
  • func (in *SchedulerList) DeepCopy() *SchedulerList
  • func (in *SchedulerList) DeepCopyInto(out *SchedulerList)
  • func (in *SchedulerList) DeepCopyObject() runtime.Object
• type SchedulerSpec
  • func (in *SchedulerSpec) DeepCopy() *SchedulerSpec
  • func (in *SchedulerSpec) DeepCopyInto(out *SchedulerSpec)
• type SchedulerStatus
  • func (in *SchedulerStatus) DeepCopy() *SchedulerStatus
  • func (in *SchedulerStatus) DeepCopyInto(out *SchedulerStatus)
• type SecretRef
  • func (in *SecretRef) DeepCopy() *SecretRef
  • func (in *SecretRef) DeepCopyInto(out *SecretRef)
• type TargetTypeEnum

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "gcp-contrib.alleypinapis.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
)

Types

type AppEngineHttpTarget

type AppEngineHttpTarget struct {
	Method      string            `json:"method"`
	Service     string            `json:"service"`
	Version     string            `json:"version"`
	Instance    string            `json:"instance"`
	Host        string            `json:"host"`
	RelativeUri string            `json:"relativeUri"`
	Headers     map[string]string `json:"headers"`
	Body        string            `json:"body"`
}

func (*AppEngineHttpTarget) DeepCopy

func (in *AppEngineHttpTarget) DeepCopy() *AppEngineHttpTarget

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

func (*AppEngineHttpTarget) DeepCopyInto

func (in *AppEngineHttpTarget) DeepCopyInto(out *AppEngineHttpTarget)

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

type HttpTarget

type HttpTarget struct {
	Uri     string            `json:"uri"`
	Method  string            `json:"method"`
	Headers map[string]string `json:"headers"`
	Body    string            `json:"body"`
}

func (*HttpTarget) DeepCopy

func (in *HttpTarget) DeepCopy() *HttpTarget

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

func (*HttpTarget) DeepCopyInto

func (in *HttpTarget) DeepCopyInto(out *HttpTarget)

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

type PubsubTarget

type PubsubTarget struct {
	TopicName  string            `json:"topicName"`
	Data       string            `json:"data"`
	Attributes map[string]string `json:"attributes"`
}

func (*PubsubTarget) DeepCopy

func (in *PubsubTarget) DeepCopy() *PubsubTarget

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

func (*PubsubTarget) DeepCopyInto

func (in *PubsubTarget) DeepCopyInto(out *PubsubTarget)

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

type RetryConfig

type RetryConfig struct {
	// Maximum number of retry attempts for a failed job
	MaxRetryAttempts int `json:"maxRetryAttempts"`

	// Time limit for retrying a failed job, 0s means unlimited
	MaxRetryDuration string `json:"maxRetryDuration"`

	// Minimum time to wait before retrying a job after it fails
	MinBackoffDuration string `json:"minBackoffDuration"`

	// Maximum time to wait before retrying a job after it fails
	MaxBackoffDuration string `json:"maxBackoffDuration"`

	// The time between retries will double max doublings times
	MaxDoublings int `json:"maxDoublings"`
}

func (*RetryConfig) DeepCopy

func (in *RetryConfig) DeepCopy() *RetryConfig

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

func (*RetryConfig) DeepCopyInto

func (in *RetryConfig) DeepCopyInto(out *RetryConfig)

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

type Scheduler

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

	Spec   SchedulerSpec   `json:"spec,omitempty"`
	Status SchedulerStatus `json:"status,omitempty"`
}

Scheduler is the Schema for the schedulers API

func (*Scheduler) DeepCopy

func (in *Scheduler) DeepCopy() *Scheduler

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

func (*Scheduler) DeepCopyInto

func (in *Scheduler) DeepCopyInto(out *Scheduler)

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

func (*Scheduler) DeepCopyObject

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

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

type SchedulerList

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

SchedulerList contains a list of Scheduler

func (*SchedulerList) DeepCopy

func (in *SchedulerList) DeepCopy() *SchedulerList

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

func (*SchedulerList) DeepCopyInto

func (in *SchedulerList) DeepCopyInto(out *SchedulerList)

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

func (*SchedulerList) DeepCopyObject

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

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

type SchedulerSpec

type SchedulerSpec struct {

	// +kubebuilder:validation:Required
	// The secretRef is a reference that provides the service account json to access google cloud api
	SecretRef *SecretRef `json:"secretRef"`

	// +kubebuilder:validation:Required
	ProjectID string `json:"projectID"`

	// +kubebuilder:validation:Required
	LocationID string `json:"locationID"`

	// +kubebuilder:validation:Required
	AppEngineLocationID string `json:"appEngineLocationID"`

	// +kubebuilder:validation:Required
	Name string `json:"name"`

	Description string `json:"description,omitempty"`

	// +kubebuilder:validation:Required
	// +kubebuilder:validation:Enum=Pubsub;AppEngineHttp;Http
	TargetType TargetTypeEnum `json:"targetType"`

	PubsubTarget        *PubsubTarget        `json:"pubsubTarget,omitempty"`
	AppEngineHttpTarget *AppEngineHttpTarget `json:"appEngineHttpTarget,omitempty"`
	HttpTarget          *HttpTarget          `json:"httpTarget,omitempty"`

	// +kubebuilder:validation:Required
	Schedule string `json:"schedule"`

	// +kubebuilder:validation:Required
	TimeZone string `json:"timeZone"`

	RetryConfig *RetryConfig `json:"retryConfig,omitempty"`
}

SchedulerSpec defines the desired state of Scheduler

func (*SchedulerSpec) DeepCopy

func (in *SchedulerSpec) DeepCopy() *SchedulerSpec

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

func (*SchedulerSpec) DeepCopyInto

func (in *SchedulerSpec) DeepCopyInto(out *SchedulerSpec)

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

type SchedulerStatus

type SchedulerStatus struct {
	Name        string `json:"name"`
	Description string `json:"description"`
	Schedule    string `json:"schedule"`
	TimeZone    string `json:"timeZone"`

	// Output only. The creation time of the job.
	UserUpdateTime metav1.Time `json:"userUpdateTime"`

	// Output only. State of the job.
	State string `json:"state"`

	RetryConfig RetryConfig `json:"retryConfig,omitempty"`
}

SchedulerStatus defines the observed state of Scheduler

func (*SchedulerStatus) DeepCopy

func (in *SchedulerStatus) DeepCopy() *SchedulerStatus

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

func (*SchedulerStatus) DeepCopyInto

func (in *SchedulerStatus) DeepCopyInto(out *SchedulerStatus)

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

type SecretRef

type SecretRef struct {
	Name      string `json:"name"`
	Namespace string `json:"namespace,omitempty"`
	DataKey   string `json:"key,omitempty"`
}

func (*SecretRef) DeepCopy

func (in *SecretRef) DeepCopy() *SecretRef

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

func (*SecretRef) DeepCopyInto

func (in *SecretRef) DeepCopyInto(out *SecretRef)

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

type TargetTypeEnum

type TargetTypeEnum string

const (
	PubsubTargetType        TargetTypeEnum = "Pubsub"
	AppEngineHttpTargetType TargetTypeEnum = "AppEngineHttp"
	HttpTargetType          TargetTypeEnum = "Http"
)