v1alpha1

package
v0.0.0-...-d5b48cf Latest Latest
Warning

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

 Go to latest Published: Aug 15, 2018 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Copyright 2018 The Knative Authors Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at 

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the API. +groupName=feeds.knative.dev

Index

Constants

This section is empty.

Variables

View Source 
var (
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	AddToScheme   = SchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: feeds.GroupName, Version: "v1alpha1"}

SchemeGroupVersion is group version used to register these objects

Functions

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns back a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type ClusterEventSource 

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

	Spec   ClusterEventSourceSpec   `json:"spec"`
	Status ClusterEventSourceStatus `json:"status"`
}

ClusterEventSource represents a software system which wishes to make changes in state discoverable via eventing, without prior knowledge of systems which might consume state changes. ClusterEventSources produce events that the Feed resource connects to consumers.

func (*ClusterEventSource) CheckImmutableFields 

func (current *ClusterEventSource) CheckImmutableFields(og apis.Immutable) *apis.FieldError

func (*ClusterEventSource) DeepCopy 

func (in *ClusterEventSource) DeepCopy() *ClusterEventSource

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

func (*ClusterEventSource) DeepCopyInto 

func (in *ClusterEventSource) DeepCopyInto(out *ClusterEventSource)

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

func (*ClusterEventSource) DeepCopyObject 

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

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

func (*ClusterEventSource) SetDefaults 

func (ces *ClusterEventSource) SetDefaults()

func (*ClusterEventSource) Validate 

func (ces *ClusterEventSource) Validate() *apis.FieldError

type ClusterEventSourceList 

type ClusterEventSourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ClusterEventSource `json:"items"`
}

ClusterEventSourceList is a list of ClusterEventSource resources

func (*ClusterEventSourceList) DeepCopy 

func (in *ClusterEventSourceList) DeepCopy() *ClusterEventSourceList

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

func (*ClusterEventSourceList) DeepCopyInto 

func (in *ClusterEventSourceList) DeepCopyInto(out *ClusterEventSourceList)

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

func (*ClusterEventSourceList) DeepCopyObject 

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

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

type ClusterEventSourceSpec 

type ClusterEventSourceSpec struct {
	CommonEventSourceSpec `json:",inline"`
}

ClusterEventSourceSpec describes the type and source of an event, a container image to run for feed lifecycle operations, and configuration options for the ClusterEventSource.

func (*ClusterEventSourceSpec) DeepCopy 

func (in *ClusterEventSourceSpec) DeepCopy() *ClusterEventSourceSpec

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

func (*ClusterEventSourceSpec) DeepCopyInto 

func (in *ClusterEventSourceSpec) DeepCopyInto(out *ClusterEventSourceSpec)

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

func (*ClusterEventSourceSpec) SetDefaults 

func (cess *ClusterEventSourceSpec) SetDefaults()

func (*ClusterEventSourceSpec) Validate 

func (cess *ClusterEventSourceSpec) Validate() *apis.FieldError

type ClusterEventSourceStatus 

type ClusterEventSourceStatus struct {
	CommonEventSourceStatus `json:",inline"`
}

ClusterEventSourceStatus is the status for a ClusterEventSource resource

func (*ClusterEventSourceStatus) DeepCopy 

func (in *ClusterEventSourceStatus) DeepCopy() *ClusterEventSourceStatus

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

func (*ClusterEventSourceStatus) DeepCopyInto 

func (in *ClusterEventSourceStatus) DeepCopyInto(out *ClusterEventSourceStatus)

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

type ClusterEventType 

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

	Spec   ClusterEventTypeSpec   `json:"spec"`
	Status ClusterEventTypeStatus `json:"status"`
}

ClusterEventType is a specification for a ClusterEventType resource EventSource can expose multiple event types. For example, github has PullRequest events as well as Issues and Comments, etc.

func (*ClusterEventType) CheckImmutableFields 

func (current *ClusterEventType) CheckImmutableFields(og apis.Immutable) *apis.FieldError

func (*ClusterEventType) DeepCopy 

func (in *ClusterEventType) DeepCopy() *ClusterEventType

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

func (*ClusterEventType) DeepCopyInto 

func (in *ClusterEventType) DeepCopyInto(out *ClusterEventType)

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

func (*ClusterEventType) DeepCopyObject 

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

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

func (*ClusterEventType) GetSpecJSON 

func (et *ClusterEventType) GetSpecJSON() ([]byte, error)

func (*ClusterEventType) SetDefaults 

func (cet *ClusterEventType) SetDefaults()

func (*ClusterEventType) Validate 

func (cet *ClusterEventType) Validate() *apis.FieldError

type ClusterEventTypeList 

type ClusterEventTypeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []ClusterEventType `json:"items"`
}

ClusterEventTypeList is a list of ClusterEventType resources

func (*ClusterEventTypeList) DeepCopy 

func (in *ClusterEventTypeList) DeepCopy() *ClusterEventTypeList

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

func (*ClusterEventTypeList) DeepCopyInto 

func (in *ClusterEventTypeList) DeepCopyInto(out *ClusterEventTypeList)

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

func (*ClusterEventTypeList) DeepCopyObject 

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

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

type ClusterEventTypeSpec 

type ClusterEventTypeSpec struct {
	CommonEventTypeSpec `json:",inline"`
	// ClusterEventSource is the name of the ClusterEventSource that produces this ClusterEventType.
	ClusterEventSource string `json:"eventSource"`
}

ClusterEventTypeSpec specifies information about the ClusterEventType, including a schema for the event and information about the parameters needed to create a Feed to the event.

func (*ClusterEventTypeSpec) DeepCopy 

func (in *ClusterEventTypeSpec) DeepCopy() *ClusterEventTypeSpec

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

func (*ClusterEventTypeSpec) DeepCopyInto 

func (in *ClusterEventTypeSpec) DeepCopyInto(out *ClusterEventTypeSpec)

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

func (*ClusterEventTypeSpec) SetDefaults 

func (cets *ClusterEventTypeSpec) SetDefaults()

func (*ClusterEventTypeSpec) Validate 

func (cess *ClusterEventTypeSpec) Validate() *apis.FieldError

type ClusterEventTypeStatus 

type ClusterEventTypeStatus struct {
	CommonEventTypeStatus `json:",inline"`
}

ClusterEventTypeStatus is the status for a ClusterEventType resource

func (*ClusterEventTypeStatus) DeepCopy 

func (in *ClusterEventTypeStatus) DeepCopy() *ClusterEventTypeStatus

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

func (*ClusterEventTypeStatus) DeepCopyInto 

func (in *ClusterEventTypeStatus) DeepCopyInto(out *ClusterEventTypeStatus)

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

type CommonEventSourceCondition 

type CommonEventSourceCondition struct {
	Type CommonEventSourceConditionType `json:"type"`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

CommonEventSourceCondition defines a readiness condition for a EventSource. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties

func (*CommonEventSourceCondition) DeepCopy 

func (in *CommonEventSourceCondition) DeepCopy() *CommonEventSourceCondition

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

func (*CommonEventSourceCondition) DeepCopyInto 

func (in *CommonEventSourceCondition) DeepCopyInto(out *CommonEventSourceCondition)

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

type CommonEventSourceConditionType 

type CommonEventSourceConditionType string
const (
	// EventSourceComplete specifies that the EventSource has completed successfully.
	EventSourceComplete CommonEventSourceConditionType = "Complete"
	// EventSourceFailed specifies that the EventSource has failed.
	EventSourceFailed CommonEventSourceConditionType = "Failed"
	// EventSourceInvalid specifies that the given EventSource specification is invalid.
	EventSourceInvalid CommonEventSourceConditionType = "Invalid"
)

type CommonEventSourceSpec 

type CommonEventSourceSpec struct {
	// Source is the name of the source that produces the events.
	Source string `json:"source,omitempty"`

	// Image is the container image to run for feed lifecycle operations.
	//
	// TODO: make this a container
	// TODO: specify exactly when containers are run
	Image string `json:"image,omitempty"`

	// Parameters are configuration options for a particular EventSource
	// TODO: Consider instead using ConfigMaps and mount them instead
	// on the event sources containers.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`
}

CommonEventSourceSpec describes the type and source of an event, a container image to run for feed lifecycle operations, and configuration options common for ClusterEventSource and EventSource.

func (*CommonEventSourceSpec) DeepCopy 

func (in *CommonEventSourceSpec) DeepCopy() *CommonEventSourceSpec

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

func (*CommonEventSourceSpec) DeepCopyInto 

func (in *CommonEventSourceSpec) DeepCopyInto(out *CommonEventSourceSpec)

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

func (*CommonEventSourceSpec) SetDefaults 

func (cess *CommonEventSourceSpec) SetDefaults()

func (*CommonEventSourceSpec) Validate 

func (cess *CommonEventSourceSpec) Validate() *apis.FieldError

type CommonEventSourceStatus 

type CommonEventSourceStatus struct {
	Conditions []CommonEventSourceCondition `json:"conditions,omitempty"`
}

EventSourceStatus is the status for a EventSource resource

func (*CommonEventSourceStatus) DeepCopy 

func (in *CommonEventSourceStatus) DeepCopy() *CommonEventSourceStatus

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

func (*CommonEventSourceStatus) DeepCopyInto 

func (in *CommonEventSourceStatus) DeepCopyInto(out *CommonEventSourceStatus)

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

func (*CommonEventSourceStatus) RemoveCondition 

func (ess *CommonEventSourceStatus) RemoveCondition(t CommonEventSourceConditionType)

func (*CommonEventSourceStatus) SetCondition 

func (ess *CommonEventSourceStatus) SetCondition(new *CommonEventSourceCondition)

type CommonEventTypeCondition 

type CommonEventTypeCondition struct {
	Type CommonEventTypeConditionType `json:"type"`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`

	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

EventTypeCondition defines a readiness condition for a EventType. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties

func (*CommonEventTypeCondition) DeepCopy 

func (in *CommonEventTypeCondition) DeepCopy() *CommonEventTypeCondition

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

func (*CommonEventTypeCondition) DeepCopyInto 

func (in *CommonEventTypeCondition) DeepCopyInto(out *CommonEventTypeCondition)

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

type CommonEventTypeConditionType 

type CommonEventTypeConditionType string
const (
	// EventTypeComplete specifies that the EventType has completed successfully.
	EventTypeComplete CommonEventTypeConditionType = "Complete"
	// EventTypeFailed specifies that the EventType has failed.
	EventTypeFailed CommonEventTypeConditionType = "Failed"
	// EventTypeInvalid specifies that the given EventType specification is invalid.
	EventTypeInvalid CommonEventTypeConditionType = "Invalid"
)

type CommonEventTypeSpec 

type CommonEventTypeSpec struct {
	// Description is a human-readable description of the EventType.
	Description string `json:"description,omitempty"`
	// SubscribeSchema describing how to subscribe to this. This basically
	// defines what is required in the Feed.Parameters so that the developer
	// can see the required parameters.
	SubscribeSchema *runtime.RawExtension `json:"subscribeSchema,omitempty"`
	// Describe the schema for the events emitted by this EventType.
	EventSchema *runtime.RawExtension `json:"eventSchema,omitempty"`
}

CommonEventTypeSpec specifies information about the [Cluster]EventType, including a schema for the event and information about the parameters needed to create a Feed to the event.

func (*CommonEventTypeSpec) DeepCopy 

func (in *CommonEventTypeSpec) DeepCopy() *CommonEventTypeSpec

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

func (*CommonEventTypeSpec) DeepCopyInto 

func (in *CommonEventTypeSpec) DeepCopyInto(out *CommonEventTypeSpec)

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

func (*CommonEventTypeSpec) SetDefaults 

func (cets *CommonEventTypeSpec) SetDefaults()

func (*CommonEventTypeSpec) Validate 

func (cess *CommonEventTypeSpec) Validate() *apis.FieldError

type CommonEventTypeStatus 

type CommonEventTypeStatus struct {
	Conditions []CommonEventTypeCondition `json:"conditions,omitempty"`
}

CommonEventTypeStatus is the status for a EventType resource

func (*CommonEventTypeStatus) DeepCopy 

func (in *CommonEventTypeStatus) DeepCopy() *CommonEventTypeStatus

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

func (*CommonEventTypeStatus) DeepCopyInto 

func (in *CommonEventTypeStatus) DeepCopyInto(out *CommonEventTypeStatus)

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

func (*CommonEventTypeStatus) RemoveCondition 

func (ets *CommonEventTypeStatus) RemoveCondition(t CommonEventTypeConditionType)

func (*CommonEventTypeStatus) SetCondition 

func (ets *CommonEventTypeStatus) SetCondition(new *CommonEventTypeCondition)

type EventSource 

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

	Spec   EventSourceSpec   `json:"spec"`
	Status EventSourceStatus `json:"status"`
}

EventSource represents a software system which wishes to make changes in state discoverable via eventing, without prior knowledge of systems which might consume state changes. EventSources produce events that the Feed resource connects to consumers.

func (*EventSource) CheckImmutableFields 

func (current *EventSource) CheckImmutableFields(og apis.Immutable) *apis.FieldError

func (*EventSource) DeepCopy 

func (in *EventSource) DeepCopy() *EventSource

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

func (*EventSource) DeepCopyInto 

func (in *EventSource) DeepCopyInto(out *EventSource)

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

func (*EventSource) DeepCopyObject 

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

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

func (*EventSource) SetDefaults 

func (es *EventSource) SetDefaults()

func (*EventSource) Validate 

func (es *EventSource) Validate() *apis.FieldError

type EventSourceList 

type EventSourceList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []EventSource `json:"items"`
}

EventSourceList is a list of EventSource resources

func (*EventSourceList) DeepCopy 

func (in *EventSourceList) DeepCopy() *EventSourceList

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

func (*EventSourceList) DeepCopyInto 

func (in *EventSourceList) DeepCopyInto(out *EventSourceList)

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

func (*EventSourceList) DeepCopyObject 

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

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

type EventSourceSpec 

type EventSourceSpec struct {
	CommonEventSourceSpec `json:",inline"`
}

EventSourceSpec describes the type and source of an event, a container image to run for feed lifecycle operations, and configuration options for the EventSource.

func (*EventSourceSpec) DeepCopy 

func (in *EventSourceSpec) DeepCopy() *EventSourceSpec

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

func (*EventSourceSpec) DeepCopyInto 

func (in *EventSourceSpec) DeepCopyInto(out *EventSourceSpec)

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

func (*EventSourceSpec) SetDefaults 

func (ess *EventSourceSpec) SetDefaults()

func (*EventSourceSpec) Validate 

func (ess *EventSourceSpec) Validate() *apis.FieldError

type EventSourceStatus 

type EventSourceStatus struct {
	CommonEventSourceStatus `json:",inline"`
}

EventSourceStatus is the status for a EventSource resource

func (*EventSourceStatus) DeepCopy 

func (in *EventSourceStatus) DeepCopy() *EventSourceStatus

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

func (*EventSourceStatus) DeepCopyInto 

func (in *EventSourceStatus) DeepCopyInto(out *EventSourceStatus)

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

type EventTrigger 

type EventTrigger struct {
	// EventType or ClusterEventType Required. The type of event to observe.
	// For example:
	//   `google.storage.object.finalize` and
	//   `google.firebase.analytics.event.log`.
	//
	// Event type consists of three parts:
	//  1. namespace: The domain name of the organization in reverse-domain
	//     notation (e.g. `acme.net` appears as `net.acme`) and any orginization
	//     specific subdivisions. If the organization's top-level domain is `com`,
	//     the top-level domain is ommited (e.g. `google.com` appears as
	//     `google`). For example, `google.storage` and
	//     `google.firebase.analytics`.
	//  2. resource type: The type of resource on which event occurs. For
	//     example, the Google Cloud Storage API includes the types `object`
	//     and `bucket`.
	//  3. action: The action that generates the event. For example, actions for
	//     a Google Cloud Storage Object include 'finalize' and 'delete'.
	// These parts are lower case and joined by '.'.
	EventType string `json:"eventType"`

	// EventType or ClusterEventType Required. ClusterEventType is the same as
	// EventType but Cluster scoped.
	ClusterEventType string `json:"clusterEventType"`

	// Required. The resource(s) from which to observe events, for example,
	// `projects/_/buckets/myBucket/objects/{objectPath=**}`.
	//
	// Can be a specific resource or use wildcards to match a set of resources.
	// Wildcards can either match a single segment in the resource name,
	// using '*', or multiple segments, using '**'. For example,
	// `projects/myProject/buckets/*/objects/**` would match all objects in all
	// buckets in the 'myProject' project.
	//
	// The contents of wildcards can also be captured. This is done by assigning
	// it to a variable name in braces. For example,
	// `projects/myProject/buckets/{bucket_id=*}/objects/{object_path=**}`.
	// Additionally, a single segment capture can omit `=*` and a multiple segment
	// capture can specify additional structure. For example, the following
	// all match the same buckets, but capture different data:
	//     `projects/myProject/buckets/*/objects/users/*/data/**`
	//     `projects/myProject/buckets/{bucket_id=*}/objects/users/{user_id}/data/{data_path=**}`
	//     `projects/myProject/buckets/{bucket_id}/objects/{object_path=users/*/data/**}`
	//
	// Not all syntactically correct values are accepted by all services. For
	// example:
	//
	// 1. The authorization model must support it. Google Cloud Functions
	//    only allows EventTriggers to be deployed that observe resources in the
	//    same project as the `CloudFunction`.
	// 2. The resource type must match the pattern expected for an
	//    `event_type`. For example, an `EventTrigger` that has an
	//    `event_type` of "google.pubsub.topic.publish" should have a resource
	//    that matches Google Cloud Pub/Sub topics.
	//
	// Additionally, some services may support short names when creating an
	// `EventTrigger`. These will always be returned in the normalized "long"
	// format.
	//
	// See each *service's* documentation for supported formats.
	Resource string `json:"resource"`

	// The hostname of the service that should be observed.
	//
	// If no string is provided, the default service implementing the API will
	// be used. For example, `storage.googleapis.com` is the default for all
	// event types in the 'google.storage` namespace.
	Service string `json:"service"`

	// Parameters is what's necessary to create the subscription.
	// This is specific to each Source. Opaque to platform, only consumed
	// by the actual trigger actuator.
	// NOTE: experimental field.
	Parameters *runtime.RawExtension `json:"parameters,omitempty"`

	// ParametersFrom are pointers to secrets that contain sensitive
	// parameters. Opaque to platform, merged in with Parameters and consumed
	// by the actual trigger actuator.
	// NOTE: experimental field. All secrets in ParametersFrom will be
	// resolved and given to event sources in the Parameters field.
	ParametersFrom []ParametersFromSource `json:"parametersFrom,omitempty"`
}

EventTrigger specifies the intention that a particular event type and resource should be consumed.

func (*EventTrigger) DeepCopy 

func (in *EventTrigger) DeepCopy() *EventTrigger

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

func (*EventTrigger) DeepCopyInto 

func (in *EventTrigger) DeepCopyInto(out *EventTrigger)

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

func (*EventTrigger) Validate 

func (et *EventTrigger) Validate() *apis.FieldError

type EventType 

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

	Spec   EventTypeSpec   `json:"spec"`
	Status EventTypeStatus `json:"status"`
}

EventType is a specification for a EventType resource EventSource can expose multiple event types. For example, github has PullRequest events as well as Issues and Comments, etc.

func (*EventType) CheckImmutableFields 

func (current *EventType) CheckImmutableFields(og apis.Immutable) *apis.FieldError

func (*EventType) DeepCopy 

func (in *EventType) DeepCopy() *EventType

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

func (*EventType) DeepCopyInto 

func (in *EventType) DeepCopyInto(out *EventType)

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

func (*EventType) DeepCopyObject 

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

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

func (*EventType) GetSpecJSON 

func (et *EventType) GetSpecJSON() ([]byte, error)

func (*EventType) SetDefaults 

func (et *EventType) SetDefaults()

func (*EventType) Validate 

func (et *EventType) Validate() *apis.FieldError

type EventTypeList 

type EventTypeList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []EventType `json:"items"`
}

EventTypeList is a list of EventType resources

func (*EventTypeList) DeepCopy 

func (in *EventTypeList) DeepCopy() *EventTypeList

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

func (*EventTypeList) DeepCopyInto 

func (in *EventTypeList) DeepCopyInto(out *EventTypeList)

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

func (*EventTypeList) DeepCopyObject 

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

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

type EventTypeSpec 

type EventTypeSpec struct {
	CommonEventTypeSpec `json:",inline"`
	// EventSource is the name of the EventSource that produces this EventType.
	EventSource string `json:"eventSource"`
}

EventTypeSpec specifies information about the EventType, including a schema for the event and information about the parameters needed to create a Feed to the event.

func (*EventTypeSpec) DeepCopy 

func (in *EventTypeSpec) DeepCopy() *EventTypeSpec

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

func (*EventTypeSpec) DeepCopyInto 

func (in *EventTypeSpec) DeepCopyInto(out *EventTypeSpec)

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

func (*EventTypeSpec) SetDefaults 

func (ets *EventTypeSpec) SetDefaults()

func (*EventTypeSpec) Validate 

func (ets *EventTypeSpec) Validate() *apis.FieldError

type EventTypeStatus 

type EventTypeStatus struct {
	CommonEventTypeStatus `json:",inline"`
}

EventTypeStatus is the status for a EventType resource

func (*EventTypeStatus) DeepCopy 

func (in *EventTypeStatus) DeepCopy() *EventTypeStatus

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

func (*EventTypeStatus) DeepCopyInto 

func (in *EventTypeStatus) DeepCopyInto(out *EventTypeStatus)

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

type Feed 

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

	Spec   FeedSpec   `json:"spec"`
	Status FeedStatus `json:"status"`
}

Feed connects an event trigger with an action that processes events produced by the trigger. Feeds are building blocks used to implement Flows and are not expected to be used directly.

func (*Feed) AddFinalizer 

func (f *Feed) AddFinalizer(value string)

AddFinalizer adds the given value to the list of finalizers if it doesn't already exist.

func (*Feed) CheckImmutableFields 

func (current *Feed) CheckImmutableFields(og apis.Immutable) *apis.FieldError

func (*Feed) DeepCopy 

func (in *Feed) DeepCopy() *Feed

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

func (*Feed) DeepCopyInto 

func (in *Feed) DeepCopyInto(out *Feed)

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

func (*Feed) DeepCopyObject 

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

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

func (*Feed) GetSpecJSON 

func (f *Feed) GetSpecJSON() ([]byte, error)

func (*Feed) HasFinalizer 

func (f *Feed) HasFinalizer(value string) bool

HasFinalizer returns true if a finalizer exists, or false otherwise.

func (*Feed) RemoveFinalizer 

func (f *Feed) RemoveFinalizer(value string)

RemoveFinalizer removes the given value from the list of finalizers if it exists.

func (*Feed) SetDefaults 

func (f *Feed) SetDefaults()

func (*Feed) SetOwnerReference 

func (f *Feed) SetOwnerReference(or *metav1.OwnerReference)

SetOwnerReference adds the given owner reference to the list of owner references, replacing the corresponding owner reference if it exists.

func (*Feed) Validate 

func (f *Feed) Validate() *apis.FieldError

type FeedAction 

type FeedAction struct {
	// DNSName is the target for this feed.
	DNSName string `json:"dnsName,omitempty"`
}

FeedAction specifies the target handler - a Knative route or channel - for events produced by an EventTrigger.

func (*FeedAction) DeepCopy 

func (in *FeedAction) DeepCopy() *FeedAction

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

func (*FeedAction) DeepCopyInto 

func (in *FeedAction) DeepCopyInto(out *FeedAction)

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

func (*FeedAction) Validate 

func (fa *FeedAction) Validate() *apis.FieldError

type FeedCondition 

type FeedCondition struct {
	Type FeedConditionType `json:"type"`

	Status corev1.ConditionStatus `json:"status" description:"status of the condition, one of True, False, Unknown"`
	// +optional
	Reason string `json:"reason,omitempty" description:"one-word CamelCase reason for the condition's last transition"`
	// +optional
	Message string `json:"message,omitempty" description:"human-readable message indicating details about last transition"`
}

FeedCondition defines a readiness condition for a Feed. See: https://github.com/kubernetes/community/blob/master/contributors/devel/api-conventions.md#typical-status-properties

func (*FeedCondition) DeepCopy 

func (in *FeedCondition) DeepCopy() *FeedCondition

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

func (*FeedCondition) DeepCopyInto 

func (in *FeedCondition) DeepCopyInto(out *FeedCondition)

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

type FeedConditionType 

type FeedConditionType string
const (
	// FeedConditionReady specifies that the feed has started successfully.
	FeedConditionReady FeedConditionType = "Ready"

	// FeedConditionDependenciesSatisfied specifies that all the dependencies for
	// feed have been satisfied
	FeedConditionDependenciesSatisfied FeedConditionType = "DependenciesSatisfied"
)

type FeedList 

type FeedList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata"`

	Items []Feed `json:"items"`
}

FeedList is a list of Feed resources

func (*FeedList) DeepCopy 

func (in *FeedList) DeepCopy() *FeedList

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

func (*FeedList) DeepCopyInto 

func (in *FeedList) DeepCopyInto(out *FeedList)

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

func (*FeedList) DeepCopyObject 

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

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

type FeedSpec 

type FeedSpec struct {
	// Action specifies the target handler for the events
	Action FeedAction `json:"action"`

	// Trigger specifies the trigger producing events for this feed
	Trigger EventTrigger `json:"trigger"`

	// Service Account to run feed container. If left out, uses "default"
	ServiceAccountName string `json:"serviceAccountName,omitempty"`
}

FeedSpec is the spec for a Feed resource.

func (*FeedSpec) DeepCopy 

func (in *FeedSpec) DeepCopy() *FeedSpec

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

func (*FeedSpec) DeepCopyInto 

func (in *FeedSpec) DeepCopyInto(out *FeedSpec)

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

func (*FeedSpec) SetDefaults 

func (fs *FeedSpec) SetDefaults()

func (*FeedSpec) Validate 

func (fs *FeedSpec) Validate() *apis.FieldError

type FeedStatus 

type FeedStatus struct {
	Conditions []FeedCondition `json:"conditions,omitempty"`

	// FeedContext is what the Feed operation returns and holds enough information
	// for the event source to stop the Feed.
	// This is specific to each Feed. Opaque to platform, only consumed
	// by the actual trigger actuator.
	// NOTE: experimental field.
	FeedContext *runtime.RawExtension `json:"feedContext,omitempty"`
}

FeedStatus is the status for a Feed resource

func (*FeedStatus) DeepCopy 

func (in *FeedStatus) DeepCopy() *FeedStatus

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

func (*FeedStatus) DeepCopyInto 

func (in *FeedStatus) DeepCopyInto(out *FeedStatus)

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

func (*FeedStatus) GetCondition 

func (fs *FeedStatus) GetCondition(t FeedConditionType) *FeedCondition

func (*FeedStatus) InitializeConditions 

func (fs *FeedStatus) InitializeConditions()

func (*FeedStatus) RemoveCondition 

func (fs *FeedStatus) RemoveCondition(t FeedConditionType)

func (*FeedStatus) SetCondition 

func (fs *FeedStatus) SetCondition(new *FeedCondition)

type ParametersFromSource 

type ParametersFromSource struct {
	// The Secret key to select from.
	// The value must be a JSON object.
	//+optional
	SecretKeyRef *SecretKeyReference `json:"secretKeyRef,omitempty"`
}

ParametersFromSource represents the source of a set of Parameters TODO: consider making this into a new secret type.

func (*ParametersFromSource) DeepCopy 

func (in *ParametersFromSource) DeepCopy() *ParametersFromSource

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

func (*ParametersFromSource) DeepCopyInto 

func (in *ParametersFromSource) DeepCopyInto(out *ParametersFromSource)

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

type SecretKeyReference 

type SecretKeyReference struct {
	// The name of the secret in the resource's namespace to select from.
	Name string `json:"name"`
	// The key of the secret to select from.  Must be a valid secret key.
	Key string `json:"key"`
}

SecretKeyReference references a key of a Secret.

func (*SecretKeyReference) DeepCopy 

func (in *SecretKeyReference) DeepCopy() *SecretKeyReference

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

func (*SecretKeyReference) DeepCopyInto 

func (in *SecretKeyReference) DeepCopyInto(out *SecretKeyReference)

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.