v1alpha1

package
v0.10.0 Latest Latest
Warning

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

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

Documentation

Overview

+kubebuilder:object:generate=true +groupName=user.github.upbound.io +versionName=v1alpha1

Index

Constants

View Source 
const (
	CRDGroup   = "user.github.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 (
	Membership_Kind             = "Membership"
	Membership_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Membership_Kind}.String()
	Membership_KindAPIVersion   = Membership_Kind + "." + CRDGroupVersion.String()
	Membership_GroupVersionKind = CRDGroupVersion.WithKind(Membership_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Membership 

type Membership 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.username) || (has(self.initProvider) && has(self.initProvider.username))",message="spec.forProvider.username is a required parameter"
	Spec   MembershipSpec   `json:"spec"`
	Status MembershipStatus `json:"status,omitempty"`
}

Membership is the Schema for the Memberships API. Provides a GitHub membership resource. +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,github}

func (*Membership) DeepCopy 

func (in *Membership) DeepCopy() *Membership

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

func (*Membership) DeepCopyInto 

func (in *Membership) DeepCopyInto(out *Membership)

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

func (*Membership) DeepCopyObject 

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

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

func (*Membership) GetCondition 

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

GetCondition of this Membership.

func (*Membership) GetConnectionDetailsMapping 

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

GetConnectionDetailsMapping for this Membership

func (*Membership) GetDeletionPolicy 

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

GetDeletionPolicy of this Membership.

func (*Membership) GetID 

func (tr *Membership) GetID() string

GetID returns ID of underlying Terraform resource of this Membership

func (*Membership) GetInitParameters 

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

GetInitParameters of this Membership

func (*Membership) GetManagementPolicies 

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

GetManagementPolicies of this Membership.

func (*Membership) GetMergedParameters 

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

GetInitParameters of this Membership

func (*Membership) GetObservation 

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

GetObservation of this Membership

func (*Membership) GetParameters 

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

GetParameters of this Membership

func (*Membership) GetProviderConfigReference 

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

GetProviderConfigReference of this Membership.

func (*Membership) GetPublishConnectionDetailsTo 

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

GetPublishConnectionDetailsTo of this Membership.

func (*Membership) GetTerraformResourceType 

func (mg *Membership) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Membership

func (*Membership) GetTerraformSchemaVersion 

func (tr *Membership) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Membership) GetWriteConnectionSecretToReference 

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

GetWriteConnectionSecretToReference of this Membership.

func (*Membership) Hub 

func (tr *Membership) Hub()

Hub marks this type as a conversion hub.

func (*Membership) LateInitialize 

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

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

func (*Membership) SetConditions 

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

SetConditions of this Membership.

func (*Membership) SetDeletionPolicy 

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

SetDeletionPolicy of this Membership.

func (*Membership) SetManagementPolicies 

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

SetManagementPolicies of this Membership.

func (*Membership) SetObservation 

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

SetObservation for this Membership

func (*Membership) SetParameters 

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

SetParameters for this Membership

func (*Membership) SetProviderConfigReference 

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

SetProviderConfigReference of this Membership.

func (*Membership) SetPublishConnectionDetailsTo 

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

SetPublishConnectionDetailsTo of this Membership.

func (*Membership) SetWriteConnectionSecretToReference 

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

SetWriteConnectionSecretToReference of this Membership.

type MembershipInitParameters 

type MembershipInitParameters struct {

	// Defaults to false. If set to true,
	// when this resource is destroyed, the member will not be removed
	// from the organization. Instead, the member's role will be
	// downgraded to 'member'.
	// Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. This is useful when wanting to downgrade admins while keeping them in the organization
	DowngradeOnDestroy *bool `json:"downgradeOnDestroy,omitempty" tf:"downgrade_on_destroy,omitempty"`

	// The role of the user within the organization.
	// Must be one of member or admin. Defaults to member.
	// admin role represents the owner role available via GitHub UI.
	// The role of the user within the organization. Must be one of 'member' or 'admin'.
	Role *string `json:"role,omitempty" tf:"role,omitempty"`

	// The user to add to the organization.
	// The user to add to the organization.
	Username *string `json:"username,omitempty" tf:"username,omitempty"`
}

func (*MembershipInitParameters) DeepCopy 

func (in *MembershipInitParameters) DeepCopy() *MembershipInitParameters

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

func (*MembershipInitParameters) DeepCopyInto 

func (in *MembershipInitParameters) DeepCopyInto(out *MembershipInitParameters)

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

type MembershipList 

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

MembershipList contains a list of Memberships

func (*MembershipList) DeepCopy 

func (in *MembershipList) DeepCopy() *MembershipList

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

func (*MembershipList) DeepCopyInto 

func (in *MembershipList) DeepCopyInto(out *MembershipList)

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

func (*MembershipList) DeepCopyObject 

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

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

func (*MembershipList) GetItems 

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

GetItems of this MembershipList.

type MembershipObservation 

type MembershipObservation struct {

	// Defaults to false. If set to true,
	// when this resource is destroyed, the member will not be removed
	// from the organization. Instead, the member's role will be
	// downgraded to 'member'.
	// Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. This is useful when wanting to downgrade admins while keeping them in the organization
	DowngradeOnDestroy *bool `json:"downgradeOnDestroy,omitempty" tf:"downgrade_on_destroy,omitempty"`

	Etag *string `json:"etag,omitempty" tf:"etag,omitempty"`

	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// The role of the user within the organization.
	// Must be one of member or admin. Defaults to member.
	// admin role represents the owner role available via GitHub UI.
	// The role of the user within the organization. Must be one of 'member' or 'admin'.
	Role *string `json:"role,omitempty" tf:"role,omitempty"`

	// The user to add to the organization.
	// The user to add to the organization.
	Username *string `json:"username,omitempty" tf:"username,omitempty"`
}

func (*MembershipObservation) DeepCopy 

func (in *MembershipObservation) DeepCopy() *MembershipObservation

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

func (*MembershipObservation) DeepCopyInto 

func (in *MembershipObservation) DeepCopyInto(out *MembershipObservation)

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

type MembershipParameters 

type MembershipParameters struct {

	// Defaults to false. If set to true,
	// when this resource is destroyed, the member will not be removed
	// from the organization. Instead, the member's role will be
	// downgraded to 'member'.
	// Instead of removing the member from the org, you can choose to downgrade their membership to 'member' when this resource is destroyed. This is useful when wanting to downgrade admins while keeping them in the organization
	// +kubebuilder:validation:Optional
	DowngradeOnDestroy *bool `json:"downgradeOnDestroy,omitempty" tf:"downgrade_on_destroy,omitempty"`

	// The role of the user within the organization.
	// Must be one of member or admin. Defaults to member.
	// admin role represents the owner role available via GitHub UI.
	// The role of the user within the organization. Must be one of 'member' or 'admin'.
	// +kubebuilder:validation:Optional
	Role *string `json:"role,omitempty" tf:"role,omitempty"`

	// The user to add to the organization.
	// The user to add to the organization.
	// +kubebuilder:validation:Optional
	Username *string `json:"username,omitempty" tf:"username,omitempty"`
}

func (*MembershipParameters) DeepCopy 

func (in *MembershipParameters) DeepCopy() *MembershipParameters

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

func (*MembershipParameters) DeepCopyInto 

func (in *MembershipParameters) DeepCopyInto(out *MembershipParameters)

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

type MembershipSpec 

type MembershipSpec struct {
	v1.ResourceSpec `json:",inline"`
	ForProvider     MembershipParameters `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 MembershipInitParameters `json:"initProvider,omitempty"`
}

MembershipSpec defines the desired state of Membership

func (*MembershipSpec) DeepCopy 

func (in *MembershipSpec) DeepCopy() *MembershipSpec

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

func (*MembershipSpec) DeepCopyInto 

func (in *MembershipSpec) DeepCopyInto(out *MembershipSpec)

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

type MembershipStatus 

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

MembershipStatus defines the observed state of Membership.

func (*MembershipStatus) DeepCopy 

func (in *MembershipStatus) DeepCopy() *MembershipStatus

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

func (*MembershipStatus) DeepCopyInto 

func (in *MembershipStatus) DeepCopyInto(out *MembershipStatus)

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.