notify

package
v1.9.0-industry.3 Latest Latest
Warning

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

Go to latest
Published: Feb 1, 2023 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause, + 8 more Imports: 4 Imported by: 19

Documentation

Overview

Package notify is the internal version of the API.

Index

Constants

View Source
const GroupName = "notify.tkestack.io"

GroupName is group name used to register these schema

Variables

View Source
var (
	// Scheme is the default instance of runtime.Scheme to which types in the TKE API are already registered.
	Scheme = runtime.NewScheme()
	// Codecs provides access to encoding and decoding for the scheme
	Codecs = serializer.NewCodecFactory(Scheme)
	// ParameterCodec handles versioning of objects that are converted to query parameters.
	ParameterCodec = runtime.NewParameterCodec(Scheme)
)
View Source
var (
	// SchemeBuilder collects functions that add things to a scheme.
	SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes)
	// AddToScheme applies all the stored functions to the scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source
var SchemeGroupVersion = schema.GroupVersion{Group: GroupName, Version: runtime.APIVersionInternal}

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 IdentityProvider qualified GroupKind

func Resource

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns back a IdentityProvider qualified GroupResource

Types

type Channel

type Channel struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired channel.
	// +optional
	Spec ChannelSpec
	// +optional
	Status ChannelStatus
}

Channel represents a message transmission channel in TKE.

func (*Channel) DeepCopy

func (in *Channel) DeepCopy() *Channel

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

func (*Channel) DeepCopyInto

func (in *Channel) DeepCopyInto(out *Channel)

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

func (*Channel) DeepCopyObject

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

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

type ChannelList

type ChannelList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of channels.
	Items []Channel
}

ChannelList is the whole list of all channels which owned by a tenant.

func (*ChannelList) DeepCopy

func (in *ChannelList) DeepCopy() *ChannelList

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

func (*ChannelList) DeepCopyInto

func (in *ChannelList) DeepCopyInto(out *ChannelList)

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

func (*ChannelList) DeepCopyObject

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

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

type ChannelPhase

type ChannelPhase string

ChannelPhase defines the phase of channel constructor.

const (
	// ChannelActived is the normal running phase.
	ChannelActived ChannelPhase = "Actived"
	// ChannelTerminating means the channel is undergoing graceful termination.
	ChannelTerminating ChannelPhase = "Terminating"
)

type ChannelSMTP

type ChannelSMTP struct {
	SMTPHost string
	SMTPPort int32
	TLS      bool
	Email    string
	Password string
}

ChannelSMTP indicates a channel configuration for sending email notifications using the SMTP server.

func (*ChannelSMTP) DeepCopy

func (in *ChannelSMTP) DeepCopy() *ChannelSMTP

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

func (*ChannelSMTP) DeepCopyInto

func (in *ChannelSMTP) DeepCopyInto(out *ChannelSMTP)

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

type ChannelSpec

type ChannelSpec struct {
	// Finalizers is an opaque list of values that must be empty to permanently remove object from storage.
	// +optional
	Finalizers  []FinalizerName
	TenantID    string
	DisplayName string
	// +optional
	TencentCloudSMS *ChannelTencentCloudSMS
	// +optional
	Wechat *ChannelWechat
	// +optional
	SMTP *ChannelSMTP
	// +optional
	Webhook *ChannelWebhook
}

ChannelSpec is a description of a channel.

func (*ChannelSpec) DeepCopy

func (in *ChannelSpec) DeepCopy() *ChannelSpec

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

func (*ChannelSpec) DeepCopyInto

func (in *ChannelSpec) DeepCopyInto(out *ChannelSpec)

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

type ChannelStatus

type ChannelStatus struct {
	// +optional
	Phase ChannelPhase `json:"phase,omitempty" protobuf:"bytes,3,opt,name=phase,casttype=ChannelPhase"`
}

ChannelStatus represents information about the status of a cluster.

func (*ChannelStatus) DeepCopy

func (in *ChannelStatus) DeepCopy() *ChannelStatus

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

func (*ChannelStatus) DeepCopyInto

func (in *ChannelStatus) DeepCopyInto(out *ChannelStatus)

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

type ChannelTencentCloudSMS

type ChannelTencentCloudSMS struct {
	AppKey   string
	SdkAppID string
	// +optional
	Extend string
}

ChannelTencentCloudSMS indicates the channel configuration for sending messages using Tencent Cloud SMS Gateway. See: https://cloud.tencent.com/document/product/382/5976

func (*ChannelTencentCloudSMS) DeepCopy

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

func (*ChannelTencentCloudSMS) DeepCopyInto

func (in *ChannelTencentCloudSMS) DeepCopyInto(out *ChannelTencentCloudSMS)

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

type ChannelWebhook

type ChannelWebhook struct {
	URL string
	// +optional
	Headers map[string]string
}

ChannelWebhook indicates a channel configuration for sending notifications to the webhook server.

func (*ChannelWebhook) DeepCopy

func (in *ChannelWebhook) DeepCopy() *ChannelWebhook

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

func (*ChannelWebhook) DeepCopyInto

func (in *ChannelWebhook) DeepCopyInto(out *ChannelWebhook)

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

type ChannelWechat

type ChannelWechat struct {
	// AppID indicates the unique credentials of the third-party user.
	// See https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183
	AppID     string
	AppSecret string
}

ChannelWechat indicates a channel configuration for sending template notifications using WeChat.

func (*ChannelWechat) DeepCopy

func (in *ChannelWechat) DeepCopy() *ChannelWechat

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

func (*ChannelWechat) DeepCopyInto

func (in *ChannelWechat) DeepCopyInto(out *ChannelWechat)

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

type ConfigMap

type ConfigMap struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta

	// Data contains the configuration data.
	// Each key must consist of alphanumeric characters, '-', '_' or '.'.
	// Values with non-UTF-8 byte sequences must use the BinaryData field.
	// The keys stored in Data must not overlap with the keys in
	// the BinaryData field, this is enforced during validation process.
	// +optional
	Data map[string]string

	// BinaryData contains the binary data.
	// Each key must consist of alphanumeric characters, '-', '_' or '.'.
	// BinaryData can contain byte sequences that are not in the UTF-8 range.
	// The keys stored in BinaryData must not overlap with the ones in
	// the Data field, this is enforced during validation process.
	// +optional
	BinaryData map[string][]byte
}

ConfigMap holds configuration data for tke to consume.

func (*ConfigMap) DeepCopy

func (in *ConfigMap) DeepCopy() *ConfigMap

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

func (*ConfigMap) DeepCopyInto

func (in *ConfigMap) DeepCopyInto(out *ConfigMap)

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

func (*ConfigMap) DeepCopyObject

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

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

type ConfigMapList

type ConfigMapList struct {
	metav1.TypeMeta

	// +optional
	metav1.ListMeta

	// Items is the list of ConfigMaps.
	Items []ConfigMap
}

ConfigMapList is a resource containing a list of ConfigMap objects.

func (*ConfigMapList) DeepCopy

func (in *ConfigMapList) DeepCopy() *ConfigMapList

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

func (*ConfigMapList) DeepCopyInto

func (in *ConfigMapList) DeepCopyInto(out *ConfigMapList)

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

func (*ConfigMapList) DeepCopyObject

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

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

type FinalizerName

type FinalizerName string

FinalizerName is the name identifying a finalizer during channel lifecycle.

const (
	// ChannelFinalize is an internal finalizer values to Channel.
	ChannelFinalize FinalizerName = "channel"
)

type Message

type Message struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired message.
	// +optional
	Spec MessageSpec
	// +optional
	Status MessageStatus
}

Message indicates a message in the notification system.

func (*Message) DeepCopy

func (in *Message) DeepCopy() *Message

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

func (*Message) DeepCopyInto

func (in *Message) DeepCopyInto(out *Message)

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

func (*Message) DeepCopyObject

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

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

type MessageList

type MessageList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of messages.
	Items []Message
}

MessageList is the whole list of all message which owned by a tenant.

func (*MessageList) DeepCopy

func (in *MessageList) DeepCopy() *MessageList

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

func (*MessageList) DeepCopyInto

func (in *MessageList) DeepCopyInto(out *MessageList)

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

func (*MessageList) DeepCopyObject

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

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

type MessagePhase

type MessagePhase string

MessagePhase indicates the status of message.

const (
	// MessageUnread indicates that the message has not been read by the receiver.
	MessageUnread MessagePhase = "Unread"
	// MessageRead indicates that the recipient has read the message.
	MessageRead MessagePhase = "Read"
)

These are valid status of message.

type MessageRequest

type MessageRequest struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired message.
	// +optional
	Spec MessageRequestSpec
	// +optional
	Status MessageRequestStatus
}

MessageRequest represents a message sending request, which may include multiple recipients and multiple receiving groups.

func (*MessageRequest) DeepCopy

func (in *MessageRequest) DeepCopy() *MessageRequest

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

func (*MessageRequest) DeepCopyInto

func (in *MessageRequest) DeepCopyInto(out *MessageRequest)

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

func (*MessageRequest) DeepCopyObject

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

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

type MessageRequestList

type MessageRequestList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of message requests.
	Items []MessageRequest
}

MessageRequestList is the whole list of all message which owned by a tenant.

func (*MessageRequestList) DeepCopy

func (in *MessageRequestList) DeepCopy() *MessageRequestList

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

func (*MessageRequestList) DeepCopyInto

func (in *MessageRequestList) DeepCopyInto(out *MessageRequestList)

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

func (*MessageRequestList) DeepCopyObject

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

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

type MessageRequestPhase

type MessageRequestPhase string

MessageRequestPhase indicates the status of message request.

const (
	// MessageRequestPending indicates that the message request has been declared, when the message
	// has not actually been sent.
	MessageRequestPending MessageRequestPhase = "Pending"
	// MessageRequestSending indicated the message is sending.
	MessageRequestSending MessageRequestPhase = "Sending"
	// MessageRequestSent indicates the message has been sent.
	MessageRequestSent MessageRequestPhase = "Sent"
	// MessageRequestFailed indicates that the message failed to be sent.
	MessageRequestFailed MessageRequestPhase = "Failed"
	// MessageRequestPartialFailure indicates that the partial failure to sent.
	MessageRequestPartialFailure MessageRequestPhase = "PartialFailure"
)

These are valid status of message request.

type MessageRequestSpec

type MessageRequestSpec struct {
	TenantID     string
	TemplateName string
	// +optional
	Receivers []string
	// +optional
	ReceiverGroups []string
	// +optional
	Variables map[string]string
}

MessageRequestSpec is a description of a message request.

func (*MessageRequestSpec) DeepCopy

func (in *MessageRequestSpec) DeepCopy() *MessageRequestSpec

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

func (*MessageRequestSpec) DeepCopyInto

func (in *MessageRequestSpec) DeepCopyInto(out *MessageRequestSpec)

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

type MessageRequestStatus

type MessageRequestStatus struct {
	// +optional
	Phase MessageRequestPhase
	// The last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time
	// A human readable message indicating details about the transition.
	// +optional
	Errors map[string]string

	//alert's status in notification sending from alertmanager
	AlertStatus string
}

MessageRequestStatus represents information about the status of a message request.

func (*MessageRequestStatus) DeepCopy

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

func (*MessageRequestStatus) DeepCopyInto

func (in *MessageRequestStatus) DeepCopyInto(out *MessageRequestStatus)

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

type MessageSpec

type MessageSpec struct {
	TenantID        string
	ReceiverName    string
	ReceiverChannel ReceiverChannel
	Identity        string
	// +optional
	Username string
	// +optional
	Header string
	// +optional
	Body string
	// +optional
	ChannelMessageID string
	// +optional
	AlarmPolicyName string
	// +optional
	AlarmPolicyType string
	// +optional
	ReceiverChannelName string
	// +optional
	ClusterID string
}

MessageSpec is a description of a message.

func (*MessageSpec) DeepCopy

func (in *MessageSpec) DeepCopy() *MessageSpec

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

func (*MessageSpec) DeepCopyInto

func (in *MessageSpec) DeepCopyInto(out *MessageSpec)

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

type MessageStatus

type MessageStatus struct {
	// +optional
	Phase MessagePhase
	// The last time the condition transitioned from one status to another.
	// +optional
	LastTransitionTime metav1.Time

	// alert's status in notification sending from alertmanager
	AlertStatus string
}

MessageStatus represents information about the status of a message.

func (*MessageStatus) DeepCopy

func (in *MessageStatus) DeepCopy() *MessageStatus

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

func (*MessageStatus) DeepCopyInto

func (in *MessageStatus) DeepCopyInto(out *MessageStatus)

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

type Receiver

type Receiver struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired receiver.
	// +optional
	Spec ReceiverSpec
}

Receiver indicates a message notification recipient, usually representing a user in the user system or a webhook service address.

func (*Receiver) DeepCopy

func (in *Receiver) DeepCopy() *Receiver

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

func (*Receiver) DeepCopyInto

func (in *Receiver) DeepCopyInto(out *Receiver)

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

func (*Receiver) DeepCopyObject

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

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

type ReceiverChannel

type ReceiverChannel string

ReceiverChannel is the name identifying various channel in a receiver.

const (
	// ReceiverChannelMobile represents the mobile of receiver.
	ReceiverChannelMobile ReceiverChannel = "mobile"
	// ReceiverChannelEmail represents the email address of receiver.
	ReceiverChannelEmail ReceiverChannel = "email"
	// ReceiverChannelWechatOpenID represents the openid for wechat of receiver.
	ReceiverChannelWechatOpenID ReceiverChannel = "wechat_openid"
	// ReceiverChannelWebhook only indicates channel type webhook
	ReceiverChannelWebhook ReceiverChannel = "webhook"
)

type ReceiverGroup

type ReceiverGroup struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired receiver group.
	// +optional
	Spec ReceiverGroupSpec
}

ReceiverGroup indicates multiple message recipients.

func (*ReceiverGroup) DeepCopy

func (in *ReceiverGroup) DeepCopy() *ReceiverGroup

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

func (*ReceiverGroup) DeepCopyInto

func (in *ReceiverGroup) DeepCopyInto(out *ReceiverGroup)

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

func (*ReceiverGroup) DeepCopyObject

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

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

type ReceiverGroupList

type ReceiverGroupList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of receiver groups.
	Items []ReceiverGroup
}

ReceiverGroupList is the whole list of all receiver which owned by a tenant.

func (*ReceiverGroupList) DeepCopy

func (in *ReceiverGroupList) DeepCopy() *ReceiverGroupList

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

func (*ReceiverGroupList) DeepCopyInto

func (in *ReceiverGroupList) DeepCopyInto(out *ReceiverGroupList)

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

func (*ReceiverGroupList) DeepCopyObject

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

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

type ReceiverGroupSpec

type ReceiverGroupSpec struct {
	TenantID    string
	DisplayName string
	// +optional
	Receivers []string
}

ReceiverGroupSpec is a description of a receiver group.

func (*ReceiverGroupSpec) DeepCopy

func (in *ReceiverGroupSpec) DeepCopy() *ReceiverGroupSpec

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

func (*ReceiverGroupSpec) DeepCopyInto

func (in *ReceiverGroupSpec) DeepCopyInto(out *ReceiverGroupSpec)

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

type ReceiverList

type ReceiverList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of receivers.
	Items []Receiver
}

ReceiverList is the whole list of all receiver which owned by a tenant.

func (*ReceiverList) DeepCopy

func (in *ReceiverList) DeepCopy() *ReceiverList

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

func (*ReceiverList) DeepCopyInto

func (in *ReceiverList) DeepCopyInto(out *ReceiverList)

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

func (*ReceiverList) DeepCopyObject

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

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

type ReceiverSpec

type ReceiverSpec struct {
	TenantID    string
	DisplayName string
	// +optional
	Username string
	// Identities represents the characteristics of the message recipient.
	// The hash table key represents the message delivery channel id, and the value represents
	// the user identification number in the channel.
	// For example, if it is a short message sending channel, then the value is the user's
	// mobile phone number; if it is a mail sending channel, then the value is the user's
	// email address.
	// +optional
	Identities map[ReceiverChannel]string
}

ReceiverSpec is a description of a receiver.

func (*ReceiverSpec) DeepCopy

func (in *ReceiverSpec) DeepCopy() *ReceiverSpec

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

func (*ReceiverSpec) DeepCopyInto

func (in *ReceiverSpec) DeepCopyInto(out *ReceiverSpec)

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

type Template

type Template struct {
	metav1.TypeMeta
	// +optional
	metav1.ObjectMeta
	// Spec defines the desired template.
	// +optional
	Spec TemplateSpec
}

Template indicates the template used to send notifications under this channel.

func (*Template) DeepCopy

func (in *Template) DeepCopy() *Template

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

func (*Template) DeepCopyInto

func (in *Template) DeepCopyInto(out *Template)

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

func (*Template) DeepCopyObject

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

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

type TemplateList

type TemplateList struct {
	metav1.TypeMeta
	// +optional
	metav1.ListMeta

	// List of templates.
	Items []Template
}

TemplateList is the whole list of all template which owned by a channel.

func (*TemplateList) DeepCopy

func (in *TemplateList) DeepCopy() *TemplateList

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

func (*TemplateList) DeepCopyInto

func (in *TemplateList) DeepCopyInto(out *TemplateList)

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

func (*TemplateList) DeepCopyObject

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

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

type TemplateSpec

type TemplateSpec struct {
	TenantID    string
	DisplayName string
	// +optional
	Keys []string
	// +optional
	TencentCloudSMS *TemplateTencentCloudSMS
	// +optional
	Wechat *TemplateWechat
	// +optional
	Text *TemplateText
}

TemplateSpec is a description of a template.

func (*TemplateSpec) DeepCopy

func (in *TemplateSpec) DeepCopy() *TemplateSpec

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

func (*TemplateSpec) DeepCopyInto

func (in *TemplateSpec) DeepCopyInto(out *TemplateSpec)

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

type TemplateTencentCloudSMS

type TemplateTencentCloudSMS struct {
	TemplateID string
	// +optional
	Sign string
	// +optional
	Body string
}

TemplateTencentCloudSMS indicates the template used when sending text messages using Tencent Cloud SMS Gateway. The template must be approved.

func (*TemplateTencentCloudSMS) DeepCopy

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

func (*TemplateTencentCloudSMS) DeepCopyInto

func (in *TemplateTencentCloudSMS) DeepCopyInto(out *TemplateTencentCloudSMS)

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

type TemplateText

type TemplateText struct {
	Body string
	// +optional
	Header string
}

TemplateText indicates the template used to send notifications using other non-templated channels.

func (*TemplateText) DeepCopy

func (in *TemplateText) DeepCopy() *TemplateText

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

func (*TemplateText) DeepCopyInto

func (in *TemplateText) DeepCopyInto(out *TemplateText)

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

type TemplateWechat

type TemplateWechat struct {
	// TemplateID indicates the template id of the template message notification.
	// See https://mp.weixin.qq.com/wiki?t=resource/res_main&id=mp1421140183
	TemplateID string
	// URL indicates the web address of the user who clicked the notification in WeChat.
	// +optional
	URL string
	// MiniProgramAppID indicates the unique identification number of the WeChat applet
	// that the user clicked on the notification in WeChat.
	// +optional
	MiniProgramAppID string
	// +optional
	MiniProgramPagePath string
	// +optional
	Body string
}

TemplateWechat indicates the template when sending a text message using the WeChat public account. The template must be approved and registered.

func (*TemplateWechat) DeepCopy

func (in *TemplateWechat) DeepCopy() *TemplateWechat

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

func (*TemplateWechat) DeepCopyInto

func (in *TemplateWechat) DeepCopyInto(out *TemplateWechat)

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

Directories

Path Synopsis
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.

Jump to

Keyboard shortcuts

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