v1alpha1

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Mar 5, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

+kubebuilder:object:generate=true +groupName=component.opensearch.upbound.io +versionName=v1alpha1

Index

Constants

View Source
const (
	CRDGroup   = "component.opensearch.upbound.io"
	CRDVersion = "v1alpha1"
)

Package type metadata.

Variables

View Source
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
)
View Source
var (
	Template_Kind             = "Template"
	Template_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Template_Kind}.String()
	Template_KindAPIVersion   = Template_Kind + "." + CRDGroupVersion.String()
	Template_GroupVersionKind = CRDGroupVersion.WithKind(Template_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Template

type Template struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.body) || (has(self.initProvider) && has(self.initProvider.body))",message="spec.forProvider.body is a required parameter"
	// +kubebuilder:validation:XValidation:rule="!('*' in self.managementPolicies || 'Create' in self.managementPolicies || 'Update' in self.managementPolicies) || has(self.forProvider.name) || (has(self.initProvider) && has(self.initProvider.name))",message="spec.forProvider.name is a required parameter"
	Spec   TemplateSpec   `json:"spec"`
	Status TemplateStatus `json:"status,omitempty"`
}

Template is the Schema for the Templates API. Component templates are building blocks for constructing index templates that specify index mappings, settings, and aliases. You cannot directly apply a component template to a data stream or index. To be applied, a component template must be included in an index template’s composed_of list. +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:resource:scope=Cluster,categories={crossplane,managed,opensearch}

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.

func (*Template) GetCondition

func (mg *Template) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Template.

func (*Template) GetConnectionDetailsMapping

func (tr *Template) GetConnectionDetailsMapping() map[string]string

GetConnectionDetailsMapping for this Template

func (*Template) GetDeletionPolicy

func (mg *Template) GetDeletionPolicy() xpv1.DeletionPolicy

GetDeletionPolicy of this Template.

func (*Template) GetID

func (tr *Template) GetID() string

GetID returns ID of underlying Terraform resource of this Template

func (*Template) GetInitParameters

func (tr *Template) GetInitParameters() (map[string]any, error)

GetInitParameters of this Template

func (*Template) GetManagementPolicies

func (mg *Template) GetManagementPolicies() xpv1.ManagementPolicies

GetManagementPolicies of this Template.

func (*Template) GetMergedParameters

func (tr *Template) GetMergedParameters(shouldMergeInitProvider bool) (map[string]any, error)

GetInitParameters of this Template

func (*Template) GetObservation

func (tr *Template) GetObservation() (map[string]any, error)

GetObservation of this Template

func (*Template) GetParameters

func (tr *Template) GetParameters() (map[string]any, error)

GetParameters of this Template

func (*Template) GetProviderConfigReference

func (mg *Template) GetProviderConfigReference() *xpv1.Reference

GetProviderConfigReference of this Template.

func (*Template) GetPublishConnectionDetailsTo

func (mg *Template) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo

GetPublishConnectionDetailsTo of this Template.

func (*Template) GetTerraformResourceType

func (mg *Template) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Template

func (*Template) GetTerraformSchemaVersion

func (tr *Template) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Template) GetWriteConnectionSecretToReference

func (mg *Template) GetWriteConnectionSecretToReference() *xpv1.SecretReference

GetWriteConnectionSecretToReference of this Template.

func (*Template) Hub

func (tr *Template) Hub()

Hub marks this type as a conversion hub.

func (*Template) LateInitialize

func (tr *Template) LateInitialize(attrs []byte) (bool, error)

LateInitialize this Template using its observed tfState. returns True if there are any spec changes for the resource.

func (*Template) SetConditions

func (mg *Template) SetConditions(c ...xpv1.Condition)

SetConditions of this Template.

func (*Template) SetDeletionPolicy

func (mg *Template) SetDeletionPolicy(r xpv1.DeletionPolicy)

SetDeletionPolicy of this Template.

func (*Template) SetManagementPolicies

func (mg *Template) SetManagementPolicies(r xpv1.ManagementPolicies)

SetManagementPolicies of this Template.

func (*Template) SetObservation

func (tr *Template) SetObservation(obs map[string]any) error

SetObservation for this Template

func (*Template) SetParameters

func (tr *Template) SetParameters(params map[string]any) error

SetParameters for this Template

func (*Template) SetProviderConfigReference

func (mg *Template) SetProviderConfigReference(r *xpv1.Reference)

SetProviderConfigReference of this Template.

func (*Template) SetPublishConnectionDetailsTo

func (mg *Template) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)

SetPublishConnectionDetailsTo of this Template.

func (*Template) SetWriteConnectionSecretToReference

func (mg *Template) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)

SetWriteConnectionSecretToReference of this Template.

type TemplateInitParameters

type TemplateInitParameters struct {

	// (String) The JSON body of the template.
	// The JSON body of the template.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// (String) Name of the component template to create.
	// Name of the component template to create.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*TemplateInitParameters) DeepCopy

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

func (*TemplateInitParameters) DeepCopyInto

func (in *TemplateInitParameters) DeepCopyInto(out *TemplateInitParameters)

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

type TemplateList

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

TemplateList contains a list of Templates

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.

func (*TemplateList) GetItems

func (l *TemplateList) GetItems() []resource.Managed

GetItems of this TemplateList.

type TemplateObservation

type TemplateObservation struct {

	// (String) The JSON body of the template.
	// The JSON body of the template.
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// (String) The ID of this resource.
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// (String) Name of the component template to create.
	// Name of the component template to create.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*TemplateObservation) DeepCopy

func (in *TemplateObservation) DeepCopy() *TemplateObservation

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

func (*TemplateObservation) DeepCopyInto

func (in *TemplateObservation) DeepCopyInto(out *TemplateObservation)

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

type TemplateParameters

type TemplateParameters struct {

	// (String) The JSON body of the template.
	// The JSON body of the template.
	// +kubebuilder:validation:Optional
	Body *string `json:"body,omitempty" tf:"body,omitempty"`

	// (String) Name of the component template to create.
	// Name of the component template to create.
	// +kubebuilder:validation:Optional
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*TemplateParameters) DeepCopy

func (in *TemplateParameters) DeepCopy() *TemplateParameters

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

func (*TemplateParameters) DeepCopyInto

func (in *TemplateParameters) DeepCopyInto(out *TemplateParameters)

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

type TemplateSpec

type TemplateSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     TemplateParameters `json:"forProvider"`
	// THIS IS A BETA FIELD. It will be honored
	// unless the Management Policies feature flag is disabled.
	// InitProvider holds the same fields as ForProvider, with the exception
	// of Identifier and other resource reference fields. The fields that are
	// in InitProvider are merged into ForProvider when the resource is created.
	// The same fields are also added to the terraform ignore_changes hook, to
	// avoid updating them after creation. This is useful for fields that are
	// required on creation, but we do not desire to update them after creation,
	// for example because of an external controller is managing them, like an
	// autoscaler.
	InitProvider TemplateInitParameters `json:"initProvider,omitempty"`
}

TemplateSpec defines the desired state of 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 TemplateStatus

type TemplateStatus struct {
	v1.ResourceStatus `json:",inline"`
	AtProvider        TemplateObservation `json:"atProvider,omitempty"`
}

TemplateStatus defines the observed state of Template.

func (*TemplateStatus) DeepCopy

func (in *TemplateStatus) DeepCopy() *TemplateStatus

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

func (*TemplateStatus) DeepCopyInto

func (in *TemplateStatus) DeepCopyInto(out *TemplateStatus)

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

Jump to

Keyboard shortcuts

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