Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=branch.littlejo.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Branch
- func (in *Branch) DeepCopy() *Branch
- func (in *Branch) DeepCopyInto(out *Branch)
- func (in *Branch) DeepCopyObject() runtime.Object
- func (mg *Branch) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Branch) GetConnectionDetailsMapping() map[string]string
- func (mg *Branch) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Branch) GetID() string
- func (tr *Branch) GetInitParameters() (map[string]any, error)
- func (mg *Branch) GetManagementPolicies() xpv1.ManagementPolicies
- func (tr *Branch) GetObservation() (map[string]any, error)
- func (tr *Branch) GetParameters() (map[string]any, error)
- func (mg *Branch) GetProviderConfigReference() *xpv1.Reference
- func (mg *Branch) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
- func (mg *Branch) GetTerraformResourceType() string
- func (tr *Branch) GetTerraformSchemaVersion() int
- func (mg *Branch) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Branch) LateInitialize(attrs []byte) (bool, error)
- func (mg *Branch) ResolveReferences(ctx context.Context, c client.Reader) error
- func (mg *Branch) SetConditions(c ...xpv1.Condition)
- func (mg *Branch) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (mg *Branch) SetManagementPolicies(r xpv1.ManagementPolicies)
- func (tr *Branch) SetObservation(obs map[string]any) error
- func (tr *Branch) SetParameters(params map[string]any) error
- func (mg *Branch) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Branch) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
- func (mg *Branch) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type BranchInitParameters
- type BranchList
- type BranchObservation
- type BranchParameters
- type BranchSpec
- type BranchStatus
Constants ¶
const ( CRDGroup = "branch.littlejo.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( Branch_Kind = "Branch" Branch_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Branch_Kind}.String() Branch_KindAPIVersion = Branch_Kind + "." + CRDGroupVersion.String() Branch_GroupVersionKind = CRDGroupVersion.WithKind(Branch_Kind) )
Repository type metadata.
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 )
Functions ¶
This section is empty.
Types ¶
type Branch ¶
type Branch 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.branch) || (has(self.initProvider) && has(self.initProvider.branch))",message="spec.forProvider.branch is a required parameter" Spec BranchSpec `json:"spec"` Status BranchStatus `json:"status,omitempty"` }
Branch is the Schema for the Branchs API. Creates and manages branches within GitHub repositories. +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,github}
func (*Branch) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Branch.
func (*Branch) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Branch) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Branch) GetCondition ¶
func (mg *Branch) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Branch.
func (*Branch) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Branch
func (*Branch) GetDeletionPolicy ¶
func (mg *Branch) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Branch.
func (*Branch) GetInitParameters ¶
GetInitParameters of this Branch
func (*Branch) GetManagementPolicies ¶
func (mg *Branch) GetManagementPolicies() xpv1.ManagementPolicies
GetManagementPolicies of this Branch.
func (*Branch) GetObservation ¶
GetObservation of this Branch
func (*Branch) GetParameters ¶
GetParameters of this Branch
func (*Branch) GetProviderConfigReference ¶
GetProviderConfigReference of this Branch.
func (*Branch) GetPublishConnectionDetailsTo ¶
func (mg *Branch) GetPublishConnectionDetailsTo() *xpv1.PublishConnectionDetailsTo
GetPublishConnectionDetailsTo of this Branch.
func (*Branch) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Branch
func (*Branch) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Branch) GetWriteConnectionSecretToReference ¶
func (mg *Branch) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Branch.
func (*Branch) LateInitialize ¶
LateInitialize this Branch using its observed tfState. returns True if there are any spec changes for the resource.
func (*Branch) ResolveReferences ¶
ResolveReferences of this Branch.
func (*Branch) SetConditions ¶
SetConditions of this Branch.
func (*Branch) SetDeletionPolicy ¶
func (mg *Branch) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Branch.
func (*Branch) SetManagementPolicies ¶
func (mg *Branch) SetManagementPolicies(r xpv1.ManagementPolicies)
SetManagementPolicies of this Branch.
func (*Branch) SetObservation ¶
SetObservation for this Branch
func (*Branch) SetParameters ¶
SetParameters for this Branch
func (*Branch) SetProviderConfigReference ¶
SetProviderConfigReference of this Branch.
func (*Branch) SetPublishConnectionDetailsTo ¶
func (mg *Branch) SetPublishConnectionDetailsTo(r *xpv1.PublishConnectionDetailsTo)
SetPublishConnectionDetailsTo of this Branch.
func (*Branch) SetWriteConnectionSecretToReference ¶
func (mg *Branch) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Branch.
type BranchInitParameters ¶
type BranchInitParameters struct { // The repository branch to create. // The repository branch to create. Branch *string `json:"branch,omitempty" tf:"branch,omitempty"` // The commit hash to start from. Defaults to the tip of source_branch. If provided, source_branch is ignored. // The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. SourceSha *string `json:"sourceSha,omitempty" tf:"source_sha,omitempty"` }
func (*BranchInitParameters) DeepCopy ¶
func (in *BranchInitParameters) DeepCopy() *BranchInitParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchInitParameters.
func (*BranchInitParameters) DeepCopyInto ¶
func (in *BranchInitParameters) DeepCopyInto(out *BranchInitParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BranchList ¶
type BranchList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Branch `json:"items"` }
BranchList contains a list of Branchs
func (*BranchList) DeepCopy ¶
func (in *BranchList) DeepCopy() *BranchList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchList.
func (*BranchList) DeepCopyInto ¶
func (in *BranchList) DeepCopyInto(out *BranchList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*BranchList) DeepCopyObject ¶
func (in *BranchList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*BranchList) GetItems ¶
func (l *BranchList) GetItems() []resource.Managed
GetItems of this BranchList.
type BranchObservation ¶
type BranchObservation struct { // The repository branch to create. // The repository branch to create. Branch *string `json:"branch,omitempty" tf:"branch,omitempty"` // An etag representing the Branch object. // An etag representing the Branch object. Etag *string `json:"etag,omitempty" tf:"etag,omitempty"` ID *string `json:"id,omitempty" tf:"id,omitempty"` // A string representing a branch reference, in the form of refs/heads/<branch>. // A string representing a branch reference, in the form of 'refs/heads/<branch>'. Ref *string `json:"ref,omitempty" tf:"ref,omitempty"` // The GitHub repository name. // The GitHub repository name. Repository *string `json:"repository,omitempty" tf:"repository,omitempty"` // A string storing the reference's HEAD commit's SHA1. // A string storing the reference's HEAD commit's SHA1. Sha *string `json:"sha,omitempty" tf:"sha,omitempty"` // The branch name to start from. Defaults to main. // The branch name to start from. Defaults to 'main'. SourceBranch *string `json:"sourceBranch,omitempty" tf:"source_branch,omitempty"` // The commit hash to start from. Defaults to the tip of source_branch. If provided, source_branch is ignored. // The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. SourceSha *string `json:"sourceSha,omitempty" tf:"source_sha,omitempty"` }
func (*BranchObservation) DeepCopy ¶
func (in *BranchObservation) DeepCopy() *BranchObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchObservation.
func (*BranchObservation) DeepCopyInto ¶
func (in *BranchObservation) DeepCopyInto(out *BranchObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BranchParameters ¶
type BranchParameters struct { // The repository branch to create. // The repository branch to create. // +kubebuilder:validation:Optional Branch *string `json:"branch,omitempty" tf:"branch,omitempty"` // The GitHub repository name. // The GitHub repository name. // +crossplane:generate:reference:type=github.com/littlejo/provider-github/apis/repository/v1alpha1.Repository // +kubebuilder:validation:Optional Repository *string `json:"repository,omitempty" tf:"repository,omitempty"` // Reference to a Repository in repository to populate repository. // +kubebuilder:validation:Optional RepositoryRef *v1.Reference `json:"repositoryRef,omitempty" tf:"-"` // Selector for a Repository in repository to populate repository. // +kubebuilder:validation:Optional RepositorySelector *v1.Selector `json:"repositorySelector,omitempty" tf:"-"` // The branch name to start from. Defaults to main. // The branch name to start from. Defaults to 'main'. // +kubebuilder:validation:Optional SourceBranch *string `json:"sourceBranch,omitempty" tf:"source_branch,omitempty"` // The commit hash to start from. Defaults to the tip of source_branch. If provided, source_branch is ignored. // The commit hash to start from. Defaults to the tip of 'source_branch'. If provided, 'source_branch' is ignored. // +kubebuilder:validation:Optional SourceSha *string `json:"sourceSha,omitempty" tf:"source_sha,omitempty"` }
func (*BranchParameters) DeepCopy ¶
func (in *BranchParameters) DeepCopy() *BranchParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchParameters.
func (*BranchParameters) DeepCopyInto ¶
func (in *BranchParameters) DeepCopyInto(out *BranchParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BranchSpec ¶
type BranchSpec struct { v1.ResourceSpec `json:",inline"` ForProvider BranchParameters `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 BranchInitParameters `json:"initProvider,omitempty"` }
BranchSpec defines the desired state of Branch
func (*BranchSpec) DeepCopy ¶
func (in *BranchSpec) DeepCopy() *BranchSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchSpec.
func (*BranchSpec) DeepCopyInto ¶
func (in *BranchSpec) DeepCopyInto(out *BranchSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type BranchStatus ¶
type BranchStatus struct { v1.ResourceStatus `json:",inline"` AtProvider BranchObservation `json:"atProvider,omitempty"` }
BranchStatus defines the observed state of Branch.
func (*BranchStatus) DeepCopy ¶
func (in *BranchStatus) DeepCopy() *BranchStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new BranchStatus.
func (*BranchStatus) DeepCopyInto ¶
func (in *BranchStatus) DeepCopyInto(out *BranchStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.