Documentation ¶
Overview ¶
+kubebuilder:object:generate=true +groupName=enterprise.grafana.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Report
- func (in *Report) DeepCopy() *Report
- func (in *Report) DeepCopyInto(out *Report)
- func (in *Report) DeepCopyObject() runtime.Object
- func (mg *Report) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Report) GetConnectionDetailsMapping() map[string]string
- func (mg *Report) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Report) GetID() string
- func (tr *Report) GetObservation() (map[string]any, error)
- func (tr *Report) GetParameters() (map[string]any, error)
- func (mg *Report) GetProviderConfigReference() *xpv1.Reference
- func (mg *Report) GetProviderReference() *xpv1.Reference
- func (mg *Report) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Report) GetTerraformResourceType() string
- func (tr *Report) GetTerraformSchemaVersion() int
- func (mg *Report) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Report) LateInitialize(attrs []byte) (bool, error)
- func (mg *Report) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *Report) SetConditions(c ...xpv1.Condition)
- func (mg *Report) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (tr *Report) SetObservation(obs map[string]any) error
- func (tr *Report) SetParameters(params map[string]any) error
- func (mg *Report) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Report) SetProviderReference(r *xpv1.Reference)
- func (mg *Report) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Report) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type ReportList
- type ReportObservation
- type ReportParameters
- type ReportSpec
- type ReportStatus
- type ScheduleObservation
- type ScheduleParameters
- type TimeRangeObservation
- type TimeRangeParameters
Constants ¶
const ( CRDGroup = "enterprise.grafana.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( // CRDGroupVersion is the API Group Version used to register the objects CRDGroupVersion = schema.GroupVersion{Group: CRDGroup, Version: CRDVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: CRDGroupVersion} // AddToScheme adds the types in this group-version to the given scheme. AddToScheme = SchemeBuilder.AddToScheme )
var ( Report_Kind = "Report" Report_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Report_Kind}.String() Report_KindAPIVersion = Report_Kind + "." + CRDGroupVersion.String() Report_GroupVersionKind = CRDGroupVersion.WithKind(Report_Kind) )
Repository type metadata.
Functions ¶
This section is empty.
Types ¶
type Report ¶
type Report struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec ReportSpec `json:"spec"` Status ReportStatus `json:"status,omitempty"` }
Report is the Schema for the Reports API. <no value> +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="EXTERNAL-NAME",type="string",JSONPath=".metadata.annotations.crossplane\\.io/external-name" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:subresource:status +kubebuilder:resource:scope=Cluster,categories={crossplane,managed,grafana}
func (*Report) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Report.
func (*Report) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Report) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Report) GetCondition ¶
func (mg *Report) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Report.
func (*Report) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Report
func (*Report) GetDeletionPolicy ¶
func (mg *Report) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Report.
func (*Report) GetObservation ¶
GetObservation of this Report
func (*Report) GetParameters ¶
GetParameters of this Report
func (*Report) GetProviderConfigReference ¶
GetProviderConfigReference of this Report.
func (*Report) GetProviderReference ¶
GetProviderReference of this Report. Deprecated: Use GetProviderConfigReference.
func (*Report) GetPublishConnectionDetailsTo ¶
func (mg *Report) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Report.
func (*Report) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Report
func (*Report) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Report) GetWriteConnectionSecretToReference ¶
func (mg *Report) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Report.
func (*Report) LateInitialize ¶
LateInitialize this Report using its observed tfState. returns True if there are any spec changes for the resource.
func (*Report) ResolveReferences ¶
ResolveReferences of this Report.
func (*Report) SetConditions ¶
SetConditions of this Report.
func (*Report) SetDeletionPolicy ¶
func (mg *Report) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Report.
func (*Report) SetObservation ¶
SetObservation for this Report
func (*Report) SetParameters ¶
SetParameters for this Report
func (*Report) SetProviderConfigReference ¶
SetProviderConfigReference of this Report.
func (*Report) SetProviderReference ¶
SetProviderReference of this Report. Deprecated: Use SetProviderConfigReference.
func (*Report) SetPublishConnectionDetailsTo ¶
func (mg *Report) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Report.
func (*Report) SetWriteConnectionSecretToReference ¶
func (mg *Report) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Report.
type ReportList ¶
type ReportList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Report `json:"items"` }
ReportList contains a list of Reports
func (*ReportList) DeepCopy ¶
func (in *ReportList) DeepCopy() *ReportList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReportList.
func (*ReportList) DeepCopyInto ¶
func (in *ReportList) DeepCopyInto(out *ReportList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ReportList) DeepCopyObject ¶
func (in *ReportList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*ReportList) GetItems ¶
func (l *ReportList) GetItems() []resource.Managed
GetItems of this ReportList.
type ReportObservation ¶
type ReportObservation struct {
ID *string `json:"id,omitempty" tf:"id,omitempty"`
}
func (*ReportObservation) DeepCopy ¶
func (in *ReportObservation) DeepCopy() *ReportObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReportObservation.
func (*ReportObservation) DeepCopyInto ¶
func (in *ReportObservation) DeepCopyInto(out *ReportObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReportParameters ¶
type ReportParameters struct { // Dashboard to be sent in the report. This field is deprecated, use `dashboard_uid` instead. // +kubebuilder:validation:Optional DashboardID *float64 `json:"dashboardId,omitempty" tf:"dashboard_id,omitempty"` // Reference to a Dashboard in oss to populate dashboardUid. // +kubebuilder:validation:Optional DashboardRef *v1.Reference `json:"dashboardRef,omitempty" tf:"-"` // Selector for a Dashboard in oss to populate dashboardUid. // +kubebuilder:validation:Optional DashboardSelector *v1.Selector `json:"dashboardSelector,omitempty" tf:"-"` // Dashboard to be sent in the report. // +crossplane:generate:reference:type=github.com/grafana/crossplane-provider-grafana/apis/oss/v1alpha1.Dashboard // +crossplane:generate:reference:extractor=github.com/grafana/crossplane-provider-grafana/config/grafana.UIDExtractor() // +crossplane:generate:reference:refFieldName=DashboardRef // +crossplane:generate:reference:selectorFieldName=DashboardSelector // +kubebuilder:validation:Optional DashboardUID *string `json:"dashboardUid,omitempty" tf:"dashboard_uid,omitempty"` // Whether to include a link to the dashboard in the report. Defaults to `true`. // +kubebuilder:validation:Optional IncludeDashboardLink *bool `json:"includeDashboardLink,omitempty" tf:"include_dashboard_link,omitempty"` // Whether to include a CSV file of table panel data. Defaults to `false`. // +kubebuilder:validation:Optional IncludeTableCsv *bool `json:"includeTableCsv,omitempty" tf:"include_table_csv,omitempty"` // Layout of the report. Allowed values: `simple`, `grid`. Defaults to `grid`. // +kubebuilder:validation:Optional Layout *string `json:"layout,omitempty" tf:"layout,omitempty"` // Message to be sent in the report. // +kubebuilder:validation:Optional Message *string `json:"message,omitempty" tf:"message,omitempty"` // Name of the report. // +kubebuilder:validation:Required Name *string `json:"name" tf:"name,omitempty"` // Orientation of the report. Allowed values: `landscape`, `portrait`. Defaults to `landscape`. // +kubebuilder:validation:Optional Orientation *string `json:"orientation,omitempty" tf:"orientation,omitempty"` // List of recipients of the report. // +kubebuilder:validation:Required Recipients []*string `json:"recipients" tf:"recipients,omitempty"` // Reply-to email address of the report. // +kubebuilder:validation:Optional ReplyTo *string `json:"replyTo,omitempty" tf:"reply_to,omitempty"` // Schedule of the report. // +kubebuilder:validation:Required Schedule []ScheduleParameters `json:"schedule" tf:"schedule,omitempty"` // Time range of the report. // +kubebuilder:validation:Optional TimeRange []TimeRangeParameters `json:"timeRange,omitempty" tf:"time_range,omitempty"` }
func (*ReportParameters) DeepCopy ¶
func (in *ReportParameters) DeepCopy() *ReportParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReportParameters.
func (*ReportParameters) DeepCopyInto ¶
func (in *ReportParameters) DeepCopyInto(out *ReportParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReportSpec ¶
type ReportSpec struct { v1.ResourceSpec `json:",inline"` ForProvider ReportParameters `json:"forProvider"` }
ReportSpec defines the desired state of Report
func (*ReportSpec) DeepCopy ¶
func (in *ReportSpec) DeepCopy() *ReportSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReportSpec.
func (*ReportSpec) DeepCopyInto ¶
func (in *ReportSpec) DeepCopyInto(out *ReportSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ReportStatus ¶
type ReportStatus struct { v1.ResourceStatus `json:",inline"` AtProvider ReportObservation `json:"atProvider,omitempty"` }
ReportStatus defines the observed state of Report.
func (*ReportStatus) DeepCopy ¶
func (in *ReportStatus) DeepCopy() *ReportStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReportStatus.
func (*ReportStatus) DeepCopyInto ¶
func (in *ReportStatus) DeepCopyInto(out *ReportStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScheduleObservation ¶
type ScheduleObservation struct { }
func (*ScheduleObservation) DeepCopy ¶
func (in *ScheduleObservation) DeepCopy() *ScheduleObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduleObservation.
func (*ScheduleObservation) DeepCopyInto ¶
func (in *ScheduleObservation) DeepCopyInto(out *ScheduleObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ScheduleParameters ¶
type ScheduleParameters struct { // Custom interval of the report. // **Note:** This field is only available when frequency is set to `custom`. // +kubebuilder:validation:Optional CustomInterval *string `json:"customInterval,omitempty" tf:"custom_interval,omitempty"` // End time of the report. If empty, the report will be sent indefinitely (according to frequency). Note that times will be saved as UTC in Grafana. // +kubebuilder:validation:Optional EndTime *string `json:"endTime,omitempty" tf:"end_time,omitempty"` // Frequency of the report. Allowed values: `never`, `once`, `hourly`, `daily`, `weekly`, `monthly`, `custom`. // +kubebuilder:validation:Required Frequency *string `json:"frequency" tf:"frequency,omitempty"` // Send the report on the last day of the month Defaults to `false`. // +kubebuilder:validation:Optional LastDayOfMonth *bool `json:"lastDayOfMonth,omitempty" tf:"last_day_of_month,omitempty"` // Start time of the report. If empty, the start date will be set to the creation time. Note that times will be saved as UTC in Grafana. // +kubebuilder:validation:Optional StartTime *string `json:"startTime,omitempty" tf:"start_time,omitempty"` // Whether to send the report only on work days. Defaults to `false`. // +kubebuilder:validation:Optional WorkdaysOnly *bool `json:"workdaysOnly,omitempty" tf:"workdays_only,omitempty"` }
func (*ScheduleParameters) DeepCopy ¶
func (in *ScheduleParameters) DeepCopy() *ScheduleParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ScheduleParameters.
func (*ScheduleParameters) DeepCopyInto ¶
func (in *ScheduleParameters) DeepCopyInto(out *ScheduleParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TimeRangeObservation ¶
type TimeRangeObservation struct { }
func (*TimeRangeObservation) DeepCopy ¶
func (in *TimeRangeObservation) DeepCopy() *TimeRangeObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TimeRangeObservation.
func (*TimeRangeObservation) DeepCopyInto ¶
func (in *TimeRangeObservation) DeepCopyInto(out *TimeRangeObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TimeRangeParameters ¶
type TimeRangeParameters struct { // Start of the time range. // +kubebuilder:validation:Optional From *string `json:"from,omitempty" tf:"from,omitempty"` // End of the time range. // +kubebuilder:validation:Optional To *string `json:"to,omitempty" tf:"to,omitempty"` }
func (*TimeRangeParameters) DeepCopy ¶
func (in *TimeRangeParameters) DeepCopy() *TimeRangeParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TimeRangeParameters.
func (*TimeRangeParameters) DeepCopyInto ¶
func (in *TimeRangeParameters) DeepCopyInto(out *TimeRangeParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.