Documentation
¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API.
Index ¶
- Constants
- Variables
- func Kind(kind string) schema.GroupKind
- func Resource(resource string) schema.GroupResource
- type AzureChannel
- func (in *AzureChannel) DeepCopy() *AzureChannel
- func (in *AzureChannel) DeepCopyInto(out *AzureChannel)
- func (in *AzureChannel) DeepCopyObject() runtime.Object
- func (c *AzureChannel) GetGroupVersionKind() schema.GroupVersionKind
- func (c *AzureChannel) SetDefaults(ctx context.Context)
- func (c *AzureChannel) Validate(ctx context.Context) *apis.FieldError
- type AzureChannelList
- type AzureChannelSpec
- type AzureChannelStatus
- func (in *AzureChannelStatus) DeepCopy() *AzureChannelStatus
- func (in *AzureChannelStatus) DeepCopyInto(out *AzureChannelStatus)
- func (cs *AzureChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition
- func (cs *AzureChannelStatus) InitializeConditions()
- func (cs *AzureChannelStatus) IsReady() bool
- func (cs *AzureChannelStatus) MarkChannelServiceFailed(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkChannelServiceTrue()
- func (cs *AzureChannelStatus) MarkDispatcherFailed(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkDispatcherUnknown(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkEndpointsFailed(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkEndpointsTrue()
- func (cs *AzureChannelStatus) MarkHubFailed(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkHubTrue()
- func (cs *AzureChannelStatus) MarkServiceFailed(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) MarkServiceTrue()
- func (cs *AzureChannelStatus) MarkServiceUnknown(reason, messageFormat string, messageA ...interface{})
- func (cs *AzureChannelStatus) PropagateDispatcherStatus(ds *appsv1.DeploymentStatus)
- func (cs *AzureChannelStatus) SetAddress(url *apis.URL)
Constants ¶
const ( // AzureChannelConditionReady has status True when all subconditions below have been set to True. AzureChannelConditionReady = apis.ConditionReady // AzureChannelConditionDispatcherReady has status True when a Dispatcher deployment is ready // Keyed off appsv1.DeploymentAvailable, which means minimum available replicas required are up // and running for at least minReadySeconds. AzureChannelConditionDispatcherReady apis.ConditionType = "DispatcherReady" // AzureChannelConditionServiceReady has status True when a k8s Service is ready. This // basically just means it exists because there's no meaningful status in Service. See Endpoints // below. AzureChannelConditionServiceReady apis.ConditionType = "ServiceReady" // AzureChannelConditionEndpointsReady has status True when a k8s Service Endpoints are backed // by at least one endpoint. AzureChannelConditionEndpointsReady apis.ConditionType = "EndpointsReady" // AzureChannelConditionHubReady has status True when service successfully connected to // EventHub with provided credentials AzureChannelConditionHubReady apis.ConditionType = "HubReady" // AzureChannelConditionAddressable has status true when this AzureChannel meets // the Addressable contract and has a non-empty hostname. AzureChannelConditionAddressable apis.ConditionType = "Addressable" // AzureChannelConditionChannelServiceReady has status True when a k8s Service representing the channel is ready. // Because this uses ExternalName, there are no endpoints to check. AzureChannelConditionChannelServiceReady apis.ConditionType = "ChannelServiceReady" )
Variables ¶
var ( // SchemeBuilder initializes a scheme builder SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme )
var SchemeGroupVersion = schema.GroupVersion{ Group: messaging.GroupName, Version: "v1alpha1", }
SchemeGroupVersion is group version used to register these objects.
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns a Group qualified GroupResource.
Types ¶
type AzureChannel ¶
type AzureChannel struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec AzureChannelSpec `json:"spec"` Status AzureChannelStatus `json:"status,omitempty"` }
AzureChannel is a specification for a AzureChannel resource.
func (*AzureChannel) DeepCopy ¶
func (in *AzureChannel) DeepCopy() *AzureChannel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureChannel.
func (*AzureChannel) DeepCopyInto ¶
func (in *AzureChannel) DeepCopyInto(out *AzureChannel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AzureChannel) DeepCopyObject ¶
func (in *AzureChannel) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*AzureChannel) GetGroupVersionKind ¶
func (c *AzureChannel) GetGroupVersionKind() schema.GroupVersionKind
GetGroupVersionKind returns GroupVersionKind for AzureChannels.
func (*AzureChannel) SetDefaults ¶
func (c *AzureChannel) SetDefaults(ctx context.Context)
func (*AzureChannel) Validate ¶
func (c *AzureChannel) Validate(ctx context.Context) *apis.FieldError
type AzureChannelList ¶
type AzureChannelList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata"` Items []AzureChannel `json:"items"` }
AzureChannelList is a list of AzureChannel resources.
func (*AzureChannelList) DeepCopy ¶
func (in *AzureChannelList) DeepCopy() *AzureChannelList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureChannelList.
func (*AzureChannelList) DeepCopyInto ¶
func (in *AzureChannelList) DeepCopyInto(out *AzureChannelList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AzureChannelList) DeepCopyObject ¶
func (in *AzureChannelList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type AzureChannelSpec ¶
type AzureChannelSpec struct { eventingduckv1beta1.SubscribableSpec `json:",inline"` EventHubName string `json:"event_hub_name"` EventHubRegion string `json:"event_hub_region"` SecretName string `json:"secret_name"` }
AzureChannelSpec is the spec for a AzureChannel resource.
func (*AzureChannelSpec) DeepCopy ¶
func (in *AzureChannelSpec) DeepCopy() *AzureChannelSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureChannelSpec.
func (*AzureChannelSpec) DeepCopyInto ¶
func (in *AzureChannelSpec) DeepCopyInto(out *AzureChannelSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AzureChannelSpec) SetDefaults ¶
func (cs *AzureChannelSpec) SetDefaults(ctx context.Context)
func (*AzureChannelSpec) Validate ¶
func (cs *AzureChannelSpec) Validate(ctx context.Context) *apis.FieldError
type AzureChannelStatus ¶
type AzureChannelStatus struct { // inherits duck/v1beta1 Status, 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. duckv1beta1.Status `json:",inline"` // AzureChannel is Addressable. It currently exposes the endpoint as a // fully-qualified DNS name which will distribute traffic over the // provided targets from inside the cluster. // // It generally has the form {channel}.{namespace}.svc.{cluster domain name} duckv1alpha1.AddressStatus `json:",inline"` // Subscribers is populated with the statuses of each of the Channelable's subscribers. eventingduckv1beta1.SubscribableStatus `json:",inline"` }
AzureChannelStatus is the status for a AzureChannel resource.
func (*AzureChannelStatus) DeepCopy ¶
func (in *AzureChannelStatus) DeepCopy() *AzureChannelStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AzureChannelStatus.
func (*AzureChannelStatus) DeepCopyInto ¶
func (in *AzureChannelStatus) DeepCopyInto(out *AzureChannelStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*AzureChannelStatus) GetCondition ¶
func (cs *AzureChannelStatus) GetCondition(t apis.ConditionType) *apis.Condition
GetCondition returns the condition currently associated with the given type, or nil.
func (*AzureChannelStatus) InitializeConditions ¶
func (cs *AzureChannelStatus) InitializeConditions()
InitializeConditions sets relevant unset conditions to Unknown state.
func (*AzureChannelStatus) IsReady ¶
func (cs *AzureChannelStatus) IsReady() bool
IsReady returns true if the resource is ready overall.
func (*AzureChannelStatus) MarkChannelServiceFailed ¶
func (cs *AzureChannelStatus) MarkChannelServiceFailed(reason, messageFormat string, messageA ...interface{})
MarkChannelServiceFailed marks channel service ready status failed.
func (*AzureChannelStatus) MarkChannelServiceTrue ¶
func (cs *AzureChannelStatus) MarkChannelServiceTrue()
MarkChannelServiceTrue marks channel service ready status true.
func (*AzureChannelStatus) MarkDispatcherFailed ¶
func (cs *AzureChannelStatus) MarkDispatcherFailed(reason, messageFormat string, messageA ...interface{})
MarkDispatcherFailed marks dispatcher ready status failed.
func (*AzureChannelStatus) MarkDispatcherUnknown ¶
func (cs *AzureChannelStatus) MarkDispatcherUnknown(reason, messageFormat string, messageA ...interface{})
MarkDispatcherUnknown marks dispatcher ready status unknown.
func (*AzureChannelStatus) MarkEndpointsFailed ¶
func (cs *AzureChannelStatus) MarkEndpointsFailed(reason, messageFormat string, messageA ...interface{})
MarkEndpointsFailed marks endpoints ready status False.
func (*AzureChannelStatus) MarkEndpointsTrue ¶
func (cs *AzureChannelStatus) MarkEndpointsTrue()
MarkEndpointsTrue marks endpoints ready status True.
func (*AzureChannelStatus) MarkHubFailed ¶
func (cs *AzureChannelStatus) MarkHubFailed(reason, messageFormat string, messageA ...interface{})
MarkHubFailed marks hub ready status False.
func (*AzureChannelStatus) MarkHubTrue ¶
func (cs *AzureChannelStatus) MarkHubTrue()
MarkHubTrue marks hub ready status True.
func (*AzureChannelStatus) MarkServiceFailed ¶
func (cs *AzureChannelStatus) MarkServiceFailed(reason, messageFormat string, messageA ...interface{})
MarkServiceFailed marks service ready status failed.
func (*AzureChannelStatus) MarkServiceTrue ¶
func (cs *AzureChannelStatus) MarkServiceTrue()
MarkServiceTrue marks service ready status true.
func (*AzureChannelStatus) MarkServiceUnknown ¶
func (cs *AzureChannelStatus) MarkServiceUnknown(reason, messageFormat string, messageA ...interface{})
MarkServiceUnknown marks service ready status unknown.
func (*AzureChannelStatus) PropagateDispatcherStatus ¶
func (cs *AzureChannelStatus) PropagateDispatcherStatus(ds *appsv1.DeploymentStatus)
TODO: Unify this with the ones from Eventing. Say: Broker, Trigger. PropagateDispatcherStatus marks channel dispatcher ready status failed.
func (*AzureChannelStatus) SetAddress ¶
func (cs *AzureChannelStatus) SetAddress(url *apis.URL)
SetAddress sets the address (as part of Addressable contract) and marks the correct condition.