package
1.9.2
Repository: https://github.com/tkestack/tke.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package v1 is the v1 version of the API.

# Functions

Kind takes an unqualified kind and returns back a IdentityProvider qualified GroupKind.
Resource takes an unqualified resource and returns back a IdentityProvider qualified GroupResource.

# Constants

ChannelActived is the normal running phase.
ChannelFinalize is an internal finalizer values to Channel.
ChannelTerminating means the channel is undergoing graceful termination.
GroupName is group name used to register these schema.
MessageRead indicates that the recipient has read the message.
MessageRequestFailed indicates that the message failed to be sent.
MessageRequestPartialFailure indicates that the partial failure to sent.
MessageRequestPending indicates that the message request has been declared, when the message has not actually been sent.
MessageRequestSending indicated the message is sending.
MessageRequestSent indicates the message has been sent.
MessageUnread indicates that the message has not been read by the receiver.
ReceiverChannelEmail represents the email address of receiver.
ReceiverChannelMobile represents the mobile of receiver.
ReceiverChannelWebhook only indicates channel type webhook.
ReceiverChannelWechatOpenID represents the openid for wechat of receiver.

# Variables

AddToScheme applies all the stored functions to the scheme.
Codecs provides access to encoding and decoding for the scheme.
ParameterCodec handles versioning of objects that are converted to query parameters.
Scheme is the default instance of runtime.Scheme to which types in the TKE API are already registered.
SchemeBuilder collects functions that add things to a scheme.
SchemeGroupVersion is group version used to register these objects.

# Structs

Channel represents a message transmission channel in TKE.
ChannelList is the whole list of all channels which owned by a tenant.
ChannelSMTP indicates a channel configuration for sending email notifications using the SMTP server.
ChannelSpec is a description of a channel.
ChannelStatus represents information about the status of a cluster.
ChannelTencentCloudSMS indicates the channel configuration for sending messages using Tencent Cloud SMS Gateway.
ChannelWebhook indicates a channel configuration for sending notifications to the webhook server.
ChannelWechat indicates a channel configuration for sending template notifications using WeChat.
ConfigMap holds configuration data for tke to consume.
ConfigMapList is a resource containing a list of ConfigMap objects.
Message indicates a message in the notification system.
MessageList is the whole list of all message which owned by a tenant.
MessageRequest represents a message sending request, which may include multiple recipients and multiple receiving groups.
MessageRequestList is the whole list of all message which owned by a tenant.
MessageRequestSpec is a description of a message request.
MessageRequestStatus represents information about the status of a message request.
MessageSpec is a description of a message.
MessageStatus represents information about the status of a message.
Receiver indicates a message notification recipient, usually representing a user in the user system or a webhook service address.
ReceiverGroup indicates multiple message recipients.
ReceiverGroupList is the whole list of all receiver which owned by a tenant.
ReceiverGroupSpec is a description of a receiver group.
ReceiverList is the whole list of all receiver which owned by a tenant.
ReceiverSpec is a description of a receiver.
Template indicates the template used to send notifications under this channel.
TemplateList is the whole list of all template which owned by a channel.
TemplateSpec is a description of a template.
TemplateTencentCloudSMS indicates the template used when sending text messages using Tencent Cloud SMS Gateway.
TemplateText indicates the template used to send notifications using other non-templated channels.
TemplateWechat indicates the template when sending a text message using the WeChat public account.

# Type aliases

ChannelPhase defines the phase of channel constructor.
FinalizerName is the name identifying a finalizer during channel lifecycle.
MessagePhase indicates the status of message.
MessageRequestPhase indicates the status of message request.
ReceiverChannel is the name identifying various channel in a receiver.