v1

package
v0.40.0 Latest Latest
Warning

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

Go to latest
Published: Jan 23, 2024 License: Apache-2.0 Imports: 25 Imported by: 56

Documentation

Overview

Package v1 contains API Schema definitions for the sources v1 API group. +k8s:deepcopy-gen=package +groupName=sources.knative.dev

Index

Constants

View Source
const (
	// ApiServerConditionReady has status True when the ApiServerSource is ready to send events.
	ApiServerConditionReady = apis.ConditionReady

	// ApiServerConditionSinkProvided has status True when the ApiServerSource has been configured with a sink target.
	ApiServerConditionSinkProvided apis.ConditionType = "SinkProvided"

	// ApiServerConditionDeployed has status True when the ApiServerSource has had it's deployment created.
	ApiServerConditionDeployed apis.ConditionType = "Deployed"

	// ApiServerConditionSufficientPermissions has status True when the ApiServerSource has sufficient permissions to access resources.
	ApiServerConditionSufficientPermissions apis.ConditionType = "SufficientPermissions"

	// ApiServerConditionOIDCIdentityCreated has status True when the ApiServerSource has created an OIDC identity.
	ApiServerConditionOIDCIdentityCreated apis.ConditionType = "OIDCIdentityCreated"
)
View Source
const (
	// ReferenceMode produces payloads of ObjectReference
	ReferenceMode = "Reference"
	// ResourceMode produces payloads of ResourceEvent
	ResourceMode = "Resource"
)
View Source
const (
	// ContainerSourceConditionReady has status True when the ContainerSource is ready to send events.
	ContainerSourceConditionReady = apis.ConditionReady

	// ContainerSourceConditionSinkBindingReady has status True when the ContainerSource's SinkBinding is ready.
	ContainerSourceConditionSinkBindingReady apis.ConditionType = "SinkBindingReady"

	// ContainerSourceConditionReceiveAdapterReady has status True when the ContainerSource's ReceiveAdapter is ready.
	ContainerSourceConditionReceiveAdapterReady apis.ConditionType = "ReceiveAdapterReady"

	ContainerConditionOIDCIdentityCreated apis.ConditionType = "OIDCIdentityCreated"
)
View Source
const (
	// PingSourceConditionReady has status True when the PingSource is ready to send events.
	PingSourceConditionReady = apis.ConditionReady

	// PingSourceConditionSinkProvided has status True when the PingSource has been configured with a sink target.
	PingSourceConditionSinkProvided apis.ConditionType = "SinkProvided"

	// PingSourceConditionDeployed has status True when the PingSource has had it's receive adapter deployment created.
	PingSourceConditionDeployed apis.ConditionType = "Deployed"

	// PingSourceConditionOIDCIdentityCreated has status True when the PingSource has had it's OIDC identity created.
	PingSourceConditionOIDCIdentityCreated apis.ConditionType = "OIDCIdentityCreated"
)
View Source
const (
	// SinkBindingConditionReady is configured to indicate whether the Binding
	// has been configured for resources subject to its runtime contract.
	SinkBindingConditionReady = apis.ConditionReady

	// SinkBindingConditionSinkProvided is configured to indicate whether the
	// sink has been properly extracted from the resolver.
	SinkBindingConditionSinkProvided apis.ConditionType = "SinkProvided"

	// SinkBindingConditionOIDCIdentityCreated is configured to indicate whether
	// the OIDC identity has been created for the sink.
	SinkBindingConditionOIDCIdentityCreated apis.ConditionType = "OIDCIdentityCreated"

	// SinkBindingConditionOIDCTokenSecretCreated is configured to indicate whether
	// the secret containing the OIDC token has been created for the sink.
	SinkBindingConditionOIDCTokenSecretCreated apis.ConditionType = "OIDCTokenSecretCreated"
)
View Source
const (
	// PingSourceEventType is the default PingSource CloudEvent type.
	PingSourceEventType = "dev.knative.sources.ping"
)

Variables

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

SchemeGroupVersion is group version used to register these objects

Functions

func GetSinkURI

func GetSinkURI(ctx context.Context) *apis.URL

GetSinkURI accesses the apis.URL for the Sink URI that has been associated with this context.

func GetTrustBundleConfigMapLister added in v0.40.0

func GetTrustBundleConfigMapLister(ctx context.Context) corev1listers.ConfigMapLister

func GetURIResolver

func GetURIResolver(ctx context.Context) *resolver.URIResolver

func Kind

func Kind(kind string) schema.GroupKind

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

func PingSourceSource added in v0.23.0

func PingSourceSource(namespace, name string) string

PingSourceSource returns the PingSource CloudEvent source.

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

func WithSinkURI

func WithSinkURI(ctx context.Context, uri *apis.URL) context.Context

WithSinkURI notes on the context for binding that the resolved SinkURI is the provided apis.URL.

func WithTrustBundleConfigMapLister added in v0.40.0

func WithTrustBundleConfigMapLister(ctx context.Context, lister corev1listers.ConfigMapLister) context.Context

func WithURIResolver

func WithURIResolver(ctx context.Context, resolver *resolver.URIResolver) context.Context

Types

type APIVersionKind

type APIVersionKind struct {
	// APIVersion - the API version of the resource to watch.
	APIVersion string `json:"apiVersion"`

	// Kind of the resource to watch.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind"`
}

APIVersionKind is an APIVersion and Kind tuple.

func (*APIVersionKind) DeepCopy

func (in *APIVersionKind) DeepCopy() *APIVersionKind

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

func (*APIVersionKind) DeepCopyInto

func (in *APIVersionKind) DeepCopyInto(out *APIVersionKind)

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

type APIVersionKindSelector

type APIVersionKindSelector struct {
	// APIVersion - the API version of the resource to watch.
	APIVersion string `json:"apiVersion"`

	// Kind of the resource to watch.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	Kind string `json:"kind"`

	// LabelSelector filters this source to objects to those resources pass the
	// label selector.
	// More info: http://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors
	// +optional
	LabelSelector *metav1.LabelSelector `json:"selector,omitempty"`
}

APIVersionKindSelector is an APIVersion Kind tuple with a LabelSelector.

func (*APIVersionKindSelector) DeepCopy

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

func (*APIVersionKindSelector) DeepCopyInto

func (in *APIVersionKindSelector) DeepCopyInto(out *APIVersionKindSelector)

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

type ApiServerSource

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

	Spec   ApiServerSourceSpec   `json:"spec,omitempty"`
	Status ApiServerSourceStatus `json:"status,omitempty"`
}

ApiServerSource is the Schema for the apiserversources API

func (*ApiServerSource) ConvertFrom

func (sink *ApiServerSource) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible

func (*ApiServerSource) ConvertTo

func (source *ApiServerSource) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible

func (*ApiServerSource) DeepCopy

func (in *ApiServerSource) DeepCopy() *ApiServerSource

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

func (*ApiServerSource) DeepCopyInto

func (in *ApiServerSource) DeepCopyInto(out *ApiServerSource)

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

func (*ApiServerSource) DeepCopyObject

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

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

func (*ApiServerSource) GetConditionSet

func (*ApiServerSource) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*ApiServerSource) GetGroupVersionKind

func (*ApiServerSource) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*ApiServerSource) GetStatus

func (a *ApiServerSource) GetStatus() *duckv1.Status

GetStatus retrieves the status of the ApiServerSource . Implements the KRShaped interface.

func (*ApiServerSource) GetUntypedSpec

func (s *ApiServerSource) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the ApiServerSource.

func (*ApiServerSource) SetDefaults

func (s *ApiServerSource) SetDefaults(ctx context.Context)

func (*ApiServerSource) Validate

func (c *ApiServerSource) Validate(ctx context.Context) *apis.FieldError

type ApiServerSourceList

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

ApiServerSourceList contains a list of ApiServerSource

func (*ApiServerSourceList) DeepCopy

func (in *ApiServerSourceList) DeepCopy() *ApiServerSourceList

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

func (*ApiServerSourceList) DeepCopyInto

func (in *ApiServerSourceList) DeepCopyInto(out *ApiServerSourceList)

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

func (*ApiServerSourceList) DeepCopyObject

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

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

type ApiServerSourceSpec

type ApiServerSourceSpec struct {
	// inherits duck/v1 SourceSpec, which currently provides:
	// * Sink - a reference to an object that will resolve to a domain name or
	//   a URI directly to use as the sink.
	// * CloudEventOverrides - defines overrides to control the output format
	//   and modifications of the event sent to the sink.
	duckv1.SourceSpec `json:",inline"`

	// Resource are the resources this source will track and send related
	// lifecycle events from the Kubernetes ApiServer, with an optional label
	// selector to help filter.
	// +required
	Resources []APIVersionKindSelector `json:"resources,omitempty"`

	// ResourceOwner is an additional filter to only track resources that are
	// owned by a specific resource type. If ResourceOwner matches Resources[n]
	// then Resources[n] is allowed to pass the ResourceOwner filter.
	// +optional
	ResourceOwner *APIVersionKind `json:"owner,omitempty"`

	// EventMode controls the format of the event.
	// `Reference` sends a dataref event type for the resource under watch.
	// `Resource` send the full resource lifecycle event.
	// Defaults to `Reference`
	// +optional
	EventMode string `json:"mode,omitempty"`

	// ServiceAccountName is the name of the ServiceAccount to use to run this
	// source. Defaults to default if not set.
	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// NamespaceSelector is a label selector to capture the namespaces that
	// should be watched by the source.
	// +optional
	NamespaceSelector *metav1.LabelSelector `json:"namespaceSelector,omitempty"`
}

ApiServerSourceSpec defines the desired state of ApiServerSource

func (*ApiServerSourceSpec) DeepCopy

func (in *ApiServerSourceSpec) DeepCopy() *ApiServerSourceSpec

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

func (*ApiServerSourceSpec) DeepCopyInto

func (in *ApiServerSourceSpec) DeepCopyInto(out *ApiServerSourceSpec)

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

func (*ApiServerSourceSpec) SetDefaults

func (ss *ApiServerSourceSpec) SetDefaults(ctx context.Context)

func (*ApiServerSourceSpec) Validate

func (cs *ApiServerSourceSpec) Validate(ctx context.Context) *apis.FieldError

type ApiServerSourceStatus

type ApiServerSourceStatus struct {
	// inherits duck/v1 SourceStatus, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last
	//   processed by the controller.
	// * Conditions - the latest available observations of a resource's current
	//   state.
	// * SinkURI - the current active sink URI that has been configured for the
	//   Source.
	duckv1.SourceStatus `json:",inline"`

	// Namespaces show the namespaces currently watched by the ApiServerSource
	Namespaces []string `json:"namespaces"`
}

ApiServerSourceStatus defines the observed state of ApiServerSource

func (*ApiServerSourceStatus) DeepCopy

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

func (*ApiServerSourceStatus) DeepCopyInto

func (in *ApiServerSourceStatus) DeepCopyInto(out *ApiServerSourceStatus)

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

func (*ApiServerSourceStatus) GetCondition

GetCondition returns the condition currently associated with the given type, or nil.

func (*ApiServerSourceStatus) GetTopLevelCondition

func (s *ApiServerSourceStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level condition.

func (*ApiServerSourceStatus) InitializeConditions

func (s *ApiServerSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*ApiServerSourceStatus) IsReady

func (s *ApiServerSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*ApiServerSourceStatus) MarkNoSink

func (s *ApiServerSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})

MarkNoSink sets the condition that the source does not have a sink configured.

func (*ApiServerSourceStatus) MarkNoSufficientPermissions

func (s *ApiServerSourceStatus) MarkNoSufficientPermissions(reason, messageFormat string, messageA ...interface{})

MarkNoSufficientPermissions sets the condition that the source does not have enough permissions to access the resources

func (*ApiServerSourceStatus) MarkOIDCIdentityCreatedFailed added in v0.39.0

func (s *ApiServerSourceStatus) MarkOIDCIdentityCreatedFailed(reason, messageFormat string, messageA ...interface{})

func (*ApiServerSourceStatus) MarkOIDCIdentityCreatedSucceeded added in v0.39.0

func (s *ApiServerSourceStatus) MarkOIDCIdentityCreatedSucceeded()

func (*ApiServerSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason added in v0.39.0

func (s *ApiServerSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason(reason, messageFormat string, messageA ...interface{})

func (*ApiServerSourceStatus) MarkOIDCIdentityCreatedUnknown added in v0.39.0

func (s *ApiServerSourceStatus) MarkOIDCIdentityCreatedUnknown(reason, messageFormat string, messageA ...interface{})

func (*ApiServerSourceStatus) MarkSink

func (s *ApiServerSourceStatus) MarkSink(addr *duckv1.Addressable)

MarkSink sets the condition that the source has a sink configured.

func (*ApiServerSourceStatus) MarkSufficientPermissions

func (s *ApiServerSourceStatus) MarkSufficientPermissions()

MarkSufficientPermissions sets the condition that the source has enough permissions to access the resources.

func (*ApiServerSourceStatus) PropagateDeploymentAvailability

func (s *ApiServerSourceStatus) PropagateDeploymentAvailability(d *appsv1.Deployment)

PropagateDeploymentAvailability uses the availability of the provided Deployment to determine if ApiServerConditionDeployed should be marked as true or false.

type ContainerSource

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

	Spec   ContainerSourceSpec   `json:"spec,omitempty"`
	Status ContainerSourceStatus `json:"status,omitempty"`
}

ContainerSource is the Schema for the containersources API

func (*ContainerSource) ConvertFrom

func (sink *ContainerSource) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible Converts obj from a higher version into v1.ContainerSource.

func (*ContainerSource) ConvertTo

func (source *ContainerSource) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible Converts source from v1.ContainerSource into a higher version.

func (*ContainerSource) DeepCopy

func (in *ContainerSource) DeepCopy() *ContainerSource

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

func (*ContainerSource) DeepCopyInto

func (in *ContainerSource) DeepCopyInto(out *ContainerSource)

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

func (*ContainerSource) DeepCopyObject

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

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

func (*ContainerSource) GetConditionSet

func (*ContainerSource) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*ContainerSource) GetGroupVersionKind

func (*ContainerSource) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*ContainerSource) GetStatus

func (c *ContainerSource) GetStatus() *duckv1.Status

GetStatus retrieves the status of the ContainerSource. Implements the KRShaped interface.

func (*ContainerSource) GetUntypedSpec

func (c *ContainerSource) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the ContainerSource.

func (*ContainerSource) SetDefaults

func (s *ContainerSource) SetDefaults(ctx context.Context)

func (*ContainerSource) Validate

func (c *ContainerSource) Validate(ctx context.Context) *apis.FieldError

type ContainerSourceList

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

ContainerSourceList contains a list of ContainerSource

func (*ContainerSourceList) DeepCopy

func (in *ContainerSourceList) DeepCopy() *ContainerSourceList

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

func (*ContainerSourceList) DeepCopyInto

func (in *ContainerSourceList) DeepCopyInto(out *ContainerSourceList)

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

func (*ContainerSourceList) DeepCopyObject

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

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

type ContainerSourceSpec

type ContainerSourceSpec struct {
	// inherits duck/v1 SourceSpec, which currently provides:
	// * Sink - a reference to an object that will resolve to a domain name or
	//   a URI directly to use as the sink.
	// * CloudEventOverrides - defines overrides to control the output format
	//   and modifications of the event sent to the sink.
	duckv1.SourceSpec `json:",inline"`

	// Template describes the pods that will be created
	Template corev1.PodTemplateSpec `json:"template"`
}

ContainerSourceSpec defines the desired state of ContainerSource

func (*ContainerSourceSpec) DeepCopy

func (in *ContainerSourceSpec) DeepCopy() *ContainerSourceSpec

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

func (*ContainerSourceSpec) DeepCopyInto

func (in *ContainerSourceSpec) DeepCopyInto(out *ContainerSourceSpec)

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

func (*ContainerSourceSpec) SetDefaults

func (ss *ContainerSourceSpec) SetDefaults(ctx context.Context)

func (*ContainerSourceSpec) Validate

func (cs *ContainerSourceSpec) Validate(ctx context.Context) *apis.FieldError

type ContainerSourceStatus

type ContainerSourceStatus struct {
	// inherits duck/v1 SourceStatus, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last
	//   processed by the controller.
	// * Conditions - the latest available observations of a resource's current
	//   state.
	// * SinkURI - the current active sink URI that has been configured for the
	//   Source.
	duckv1.SourceStatus `json:",inline"`
}

ContainerSourceStatus defines the observed state of ContainerSource

func (*ContainerSourceStatus) DeepCopy

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

func (*ContainerSourceStatus) DeepCopyInto

func (in *ContainerSourceStatus) DeepCopyInto(out *ContainerSourceStatus)

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

func (*ContainerSourceStatus) GetCondition

GetCondition returns the condition currently associated with the given type, or nil.

func (*ContainerSourceStatus) GetTopLevelCondition

func (s *ContainerSourceStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level condition.

func (*ContainerSourceStatus) InitializeConditions

func (s *ContainerSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*ContainerSourceStatus) IsReady

func (s *ContainerSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*ContainerSourceStatus) MarkOIDCIdentityCreatedFailed added in v0.40.0

func (s *ContainerSourceStatus) MarkOIDCIdentityCreatedFailed(reason, messageFormat string, messageA ...interface{})

func (*ContainerSourceStatus) MarkOIDCIdentityCreatedSucceeded added in v0.40.0

func (s *ContainerSourceStatus) MarkOIDCIdentityCreatedSucceeded()

func (*ContainerSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason added in v0.40.0

func (s *ContainerSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason(reason, messageFormat string, messageA ...interface{})

func (*ContainerSourceStatus) MarkOIDCIdentityCreatedUnknown added in v0.40.0

func (s *ContainerSourceStatus) MarkOIDCIdentityCreatedUnknown(reason, messageFormat string, messageA ...interface{})

func (*ContainerSourceStatus) PropagateReceiveAdapterStatus

func (s *ContainerSourceStatus) PropagateReceiveAdapterStatus(d *appsv1.Deployment)

PropagateReceiveAdapterStatus uses the availability of the provided Deployment to determine if ContainerSourceConditionReceiveAdapterReady should be marked as true or false.

func (*ContainerSourceStatus) PropagateSinkBindingStatus

func (s *ContainerSourceStatus) PropagateSinkBindingStatus(status *SinkBindingStatus)

PropagateSinkBindingStatus uses the availability of the provided Deployment to determine if ContainerSourceConditionSinkBindingReady should be marked as true, false or unknown.

type PingSource added in v0.23.0

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

	Spec   PingSourceSpec   `json:"spec,omitempty"`
	Status PingSourceStatus `json:"status,omitempty"`
}

PingSource is the Schema for the PingSources API.

func (*PingSource) ConvertFrom added in v0.23.0

func (sink *PingSource) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible Converts source from a higher version into v1.PingSource

func (*PingSource) ConvertTo added in v0.23.0

func (source *PingSource) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible Converts source from v1.PingSource into a higher version.

func (*PingSource) DeepCopy added in v0.23.0

func (in *PingSource) DeepCopy() *PingSource

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

func (*PingSource) DeepCopyInto added in v0.23.0

func (in *PingSource) DeepCopyInto(out *PingSource)

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

func (*PingSource) DeepCopyObject added in v0.23.0

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

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

func (*PingSource) GetConditionSet added in v0.23.0

func (*PingSource) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*PingSource) GetGroupVersionKind added in v0.23.0

func (s *PingSource) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*PingSource) GetStatus added in v0.23.0

func (p *PingSource) GetStatus() *duckv1.Status

GetStatus retrieves the status of the PingSource. Implements the KRShaped interface.

func (*PingSource) GetUntypedSpec added in v0.23.0

func (s *PingSource) GetUntypedSpec() interface{}

GetUntypedSpec returns the spec of the PingSource.

func (*PingSource) SetDefaults added in v0.23.0

func (s *PingSource) SetDefaults(ctx context.Context)

func (*PingSource) Validate added in v0.23.0

func (c *PingSource) Validate(ctx context.Context) *apis.FieldError

type PingSourceList added in v0.23.0

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

PingSourceList contains a list of PingSources.

func (*PingSourceList) DeepCopy added in v0.23.0

func (in *PingSourceList) DeepCopy() *PingSourceList

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

func (*PingSourceList) DeepCopyInto added in v0.23.0

func (in *PingSourceList) DeepCopyInto(out *PingSourceList)

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

func (*PingSourceList) DeepCopyObject added in v0.23.0

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

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

type PingSourceSpec added in v0.23.0

type PingSourceSpec struct {
	// inherits duck/v1 SourceSpec, which currently provides:
	// * Sink - a reference to an object that will resolve to a domain name or
	//   a URI directly to use as the sink.
	// * CloudEventOverrides - defines overrides to control the output format
	//   and modifications of the event sent to the sink.
	duckv1.SourceSpec `json:",inline"`

	// Schedule is the cron schedule. Defaults to `* * * * *`.
	// +optional
	Schedule string `json:"schedule,omitempty"`

	// Timezone modifies the actual time relative to the specified timezone.
	// Defaults to the system time zone.
	// More general information about time zones: https://www.iana.org/time-zones
	// List of valid timezone values: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
	Timezone string `json:"timezone,omitempty"`

	// ContentType is the media type of Data or DataBase64. Default is empty.
	// +optional
	ContentType string `json:"contentType,omitempty"`

	// Data is data used as the body of the event posted to the sink. Default is empty.
	// Mutually exclusive with DataBase64.
	// +optional
	Data string `json:"data,omitempty"`

	// DataBase64 is the base64-encoded string of the actual event's body posted to the sink. Default is empty.
	// Mutually exclusive with Data.
	// +optional
	DataBase64 string `json:"dataBase64,omitempty"`
}

PingSourceSpec defines the desired state of the PingSource.

func (*PingSourceSpec) DeepCopy added in v0.23.0

func (in *PingSourceSpec) DeepCopy() *PingSourceSpec

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

func (*PingSourceSpec) DeepCopyInto added in v0.23.0

func (in *PingSourceSpec) DeepCopyInto(out *PingSourceSpec)

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

func (*PingSourceSpec) SetDefaults added in v0.23.0

func (ss *PingSourceSpec) SetDefaults(ctx context.Context)

func (*PingSourceSpec) Validate added in v0.23.0

func (cs *PingSourceSpec) Validate(ctx context.Context) *apis.FieldError

type PingSourceStatus added in v0.23.0

type PingSourceStatus struct {
	// inherits duck/v1 SourceStatus, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last
	//   processed by the controller.
	// * Conditions - the latest available observations of a resource's current
	//   state.
	// * SinkURI - the current active sink URI that has been configured for the
	//   Source.
	duckv1.SourceStatus `json:",inline"`
}

PingSourceStatus defines the observed state of PingSource.

func (*PingSourceStatus) DeepCopy added in v0.23.0

func (in *PingSourceStatus) DeepCopy() *PingSourceStatus

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

func (*PingSourceStatus) DeepCopyInto added in v0.23.0

func (in *PingSourceStatus) DeepCopyInto(out *PingSourceStatus)

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

func (*PingSourceStatus) GetCondition added in v0.23.0

func (s *PingSourceStatus) GetCondition(t apis.ConditionType) *apis.Condition

GetCondition returns the condition currently associated with the given type, or nil.

func (*PingSourceStatus) GetTopLevelCondition added in v0.23.0

func (ps *PingSourceStatus) GetTopLevelCondition() *apis.Condition

GetTopLevelCondition returns the top level Condition.

func (*PingSourceStatus) InitializeConditions added in v0.23.0

func (s *PingSourceStatus) InitializeConditions()

InitializeConditions sets relevant unset conditions to Unknown state.

func (*PingSourceStatus) IsReady added in v0.23.0

func (s *PingSourceStatus) IsReady() bool

IsReady returns true if the resource is ready overall.

func (*PingSourceStatus) MarkNoSink added in v0.23.0

func (s *PingSourceStatus) MarkNoSink(reason, messageFormat string, messageA ...interface{})

MarkNoSink sets the condition that the source does not have a sink configured.

func (*PingSourceStatus) MarkOIDCIdentityCreatedFailed added in v0.39.0

func (s *PingSourceStatus) MarkOIDCIdentityCreatedFailed(reason, messageFormat string, messageA ...interface{})

func (*PingSourceStatus) MarkOIDCIdentityCreatedSucceeded added in v0.39.0

func (s *PingSourceStatus) MarkOIDCIdentityCreatedSucceeded()

func (*PingSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason added in v0.39.0

func (s *PingSourceStatus) MarkOIDCIdentityCreatedSucceededWithReason(reason, messageFormat string, messageA ...interface{})

func (*PingSourceStatus) MarkOIDCIdentityCreatedUnknown added in v0.39.0

func (s *PingSourceStatus) MarkOIDCIdentityCreatedUnknown(reason, messageFormat string, messageA ...interface{})

func (*PingSourceStatus) MarkSink added in v0.23.0

func (s *PingSourceStatus) MarkSink(uri *duckv1.Addressable)

MarkSink sets the condition that the source has a sink configured.

func (*PingSourceStatus) PropagateDeploymentAvailability added in v0.23.0

func (s *PingSourceStatus) PropagateDeploymentAvailability(d *appsv1.Deployment)

PropagateDeploymentAvailability uses the availability of the provided Deployment to determine if PingSourceConditionDeployed should be marked as true or false.

type SinkBinding

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

	Spec   SinkBindingSpec   `json:"spec"`
	Status SinkBindingStatus `json:"status"`
}

SinkBinding describes a Binding that is also a Source. The `sink` (from the Source duck) is resolved to a URL and then projected into the `subject` by augmenting the runtime contract of the referenced containers to have a `K_SINK` environment variable holding the endpoint to which to send cloud events.

func (*SinkBinding) ConvertFrom

func (sink *SinkBinding) ConvertFrom(ctx context.Context, source apis.Convertible) error

ConvertFrom implements apis.Convertible

func (*SinkBinding) ConvertTo

func (source *SinkBinding) ConvertTo(ctx context.Context, sink apis.Convertible) error

ConvertTo implements apis.Convertible

func (*SinkBinding) DeepCopy

func (in *SinkBinding) DeepCopy() *SinkBinding

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

func (*SinkBinding) DeepCopyInto

func (in *SinkBinding) DeepCopyInto(out *SinkBinding)

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

func (*SinkBinding) DeepCopyObject

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

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

func (*SinkBinding) Do

func (sb *SinkBinding) Do(ctx context.Context, ps *duckv1.WithPod)

Do implements psbinding.Bindable

func (*SinkBinding) GetBindingStatus

func (sb *SinkBinding) GetBindingStatus() duck.BindableStatus

GetBindingStatus implements psbinding.Bindable

func (*SinkBinding) GetConditionSet

func (*SinkBinding) GetConditionSet() apis.ConditionSet

GetConditionSet retrieves the condition set for this resource. Implements the KRShaped interface.

func (*SinkBinding) GetGroupVersionKind

func (*SinkBinding) GetGroupVersionKind() schema.GroupVersionKind

GetGroupVersionKind returns the GroupVersionKind.

func (*SinkBinding) GetStatus

func (s *SinkBinding) GetStatus() *duckv1.Status

GetStatus retrieves the status of the SinkBinding. Implements the KRShaped interface.

func (*SinkBinding) GetSubject

func (sb *SinkBinding) GetSubject() tracker.Reference

GetSubject implements psbinding.Bindable

func (*SinkBinding) GetUntypedSpec

func (s *SinkBinding) GetUntypedSpec() interface{}

GetUntypedSpec implements apis.HasSpec

func (*SinkBinding) SetDefaults

func (fb *SinkBinding) SetDefaults(ctx context.Context)

SetDefaults implements apis.Defaultable

func (*SinkBinding) Undo

func (sb *SinkBinding) Undo(ctx context.Context, ps *duckv1.WithPod)

func (*SinkBinding) Validate

func (fb *SinkBinding) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type SinkBindingList

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

SinkBindingList contains a list of SinkBinding

func (*SinkBindingList) DeepCopy

func (in *SinkBindingList) DeepCopy() *SinkBindingList

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

func (*SinkBindingList) DeepCopyInto

func (in *SinkBindingList) DeepCopyInto(out *SinkBindingList)

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

func (*SinkBindingList) DeepCopyObject

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

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

type SinkBindingSpec

type SinkBindingSpec struct {
	// inherits duck/v1 SourceSpec, which currently provides:
	// * Sink - a reference to an object that will resolve to a domain name or
	//   a URI directly to use as the sink.
	// * CloudEventOverrides - defines overrides to control the output format
	//   and modifications of the event sent to the sink.
	duckv1.SourceSpec `json:",inline"`

	// inherits duck/v1 BindingSpec, which currently provides:
	// * Subject - Subject references the resource(s) whose "runtime contract"
	//   should be augmented by Binding implementations.
	duckv1.BindingSpec `json:",inline"`
}

SinkBindingSpec holds the desired state of the SinkBinding (from the client).

func (*SinkBindingSpec) DeepCopy

func (in *SinkBindingSpec) DeepCopy() *SinkBindingSpec

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

func (*SinkBindingSpec) DeepCopyInto

func (in *SinkBindingSpec) DeepCopyInto(out *SinkBindingSpec)

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

func (*SinkBindingSpec) Validate

func (fbs *SinkBindingSpec) Validate(ctx context.Context) *apis.FieldError

Validate implements apis.Validatable

type SinkBindingStatus

type SinkBindingStatus struct {
	// inherits duck/v1 SourceStatus, which currently provides:
	// * ObservedGeneration - the 'Generation' of the Service that was last
	//   processed by the controller.
	// * Conditions - the latest available observations of a resource's current
	//   state.
	// * SinkURI - the current active sink URI that has been configured for the
	//   Source.
	duckv1.SourceStatus `json:",inline"`

	// OIDCTokenSecretName is the name of the secret containing the token for
	// this SinkBindings OIDC authentication
	OIDCTokenSecretName *string `json:"oidcTokenSecretName,omitempty"`
}

SinkBindingStatus communicates the observed state of the SinkBinding (from the controller).

func (*SinkBindingStatus) DeepCopy

func (in *SinkBindingStatus) DeepCopy() *SinkBindingStatus

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

func (*SinkBindingStatus) DeepCopyInto

func (in *SinkBindingStatus) DeepCopyInto(out *SinkBindingStatus)

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

func (*SinkBindingStatus) InitializeConditions

func (sbs *SinkBindingStatus) InitializeConditions()

InitializeConditions populates the SinkBindingStatus's conditions field with all of its conditions configured to Unknown.

func (*SinkBindingStatus) MarkBindingAvailable

func (sbs *SinkBindingStatus) MarkBindingAvailable()

MarkBindingAvailable marks the SinkBinding's Ready condition to True.

func (*SinkBindingStatus) MarkBindingUnavailable

func (sbs *SinkBindingStatus) MarkBindingUnavailable(reason, message string)

MarkBindingUnavailable marks the SinkBinding's Ready condition to False with the provided reason and message.

func (*SinkBindingStatus) MarkOIDCIdentityCreatedFailed added in v0.39.0

func (sbs *SinkBindingStatus) MarkOIDCIdentityCreatedFailed(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkOIDCIdentityCreatedSucceeded added in v0.39.0

func (sbs *SinkBindingStatus) MarkOIDCIdentityCreatedSucceeded()

func (*SinkBindingStatus) MarkOIDCIdentityCreatedSucceededWithReason added in v0.39.0

func (sbs *SinkBindingStatus) MarkOIDCIdentityCreatedSucceededWithReason(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkOIDCIdentityCreatedUnknown added in v0.39.0

func (sbs *SinkBindingStatus) MarkOIDCIdentityCreatedUnknown(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkOIDCTokenSecretCreatedFailed added in v0.40.0

func (sbs *SinkBindingStatus) MarkOIDCTokenSecretCreatedFailed(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkOIDCTokenSecretCreatedSuccceeded added in v0.40.0

func (sbs *SinkBindingStatus) MarkOIDCTokenSecretCreatedSuccceeded()

func (*SinkBindingStatus) MarkOIDCTokenSecretCreatedSuccceededWithReason added in v0.40.0

func (sbs *SinkBindingStatus) MarkOIDCTokenSecretCreatedSuccceededWithReason(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkOIDCTokenSecretCreatedUnknown added in v0.40.0

func (sbs *SinkBindingStatus) MarkOIDCTokenSecretCreatedUnknown(reason, messageFormat string, messageA ...interface{})

func (*SinkBindingStatus) MarkSink

func (sbs *SinkBindingStatus) MarkSink(addr *duckv1.Addressable)

MarkSink sets the condition that the source has a sink configured.

func (*SinkBindingStatus) SetObservedGeneration

func (sbs *SinkBindingStatus) SetObservedGeneration(gen int64)

SetObservedGeneration implements psbinding.BindableStatus

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL