v1beta1

package
v1.11.2 Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Overview

+kubebuilder:object:generate=true +groupName=datastore.gcp.upbound.io +versionName=v1beta1

Index

Constants

View Source 
const (
	CRDGroup   = "datastore.gcp.upbound.io"
	CRDVersion = "v1beta1"
)

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 (
	Index_Kind             = "Index"
	Index_GroupKind        = schema.GroupKind{Group: CRDGroup, Kind: Index_Kind}.String()
	Index_KindAPIVersion   = Index_Kind + "." + CRDGroupVersion.String()
	Index_GroupVersionKind = CRDGroupVersion.WithKind(Index_Kind)
)

Repository type metadata.

Functions

This section is empty.

Types

type Index 

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

Index is the Schema for the Indexs API. Describes a composite index for Firestore in Datastore Mode. +kubebuilder:printcolumn:name="SYNCED",type="string",JSONPath=".status.conditions[?(@.type=='Synced')].status" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].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,gcp}

func (*Index) DeepCopy 

func (in *Index) DeepCopy() *Index

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

func (*Index) DeepCopyInto 

func (in *Index) DeepCopyInto(out *Index)

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

func (*Index) DeepCopyObject 

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

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

func (*Index) GetCondition 

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

GetCondition of this Index.

func (*Index) GetConnectionDetailsMapping 

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

GetConnectionDetailsMapping for this Index

func (*Index) GetDeletionPolicy 

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

GetDeletionPolicy of this Index.

func (*Index) GetID 

func (tr *Index) GetID() string

GetID returns ID of underlying Terraform resource of this Index

func (*Index) GetInitParameters added in v0.35.0 

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

GetInitParameters of this Index

func (*Index) GetManagementPolicies added in v0.35.0 

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

GetManagementPolicies of this Index.

func (*Index) GetMergedParameters added in v0.40.0 

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

GetInitParameters of this Index

func (*Index) GetObservation 

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

GetObservation of this Index

func (*Index) GetParameters 

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

GetParameters of this Index

func (*Index) GetProviderConfigReference 

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

GetProviderConfigReference of this Index.

func (*Index) GetPublishConnectionDetailsTo 

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

GetPublishConnectionDetailsTo of this Index.

func (*Index) GetTerraformResourceType 

func (mg *Index) GetTerraformResourceType() string

GetTerraformResourceType returns Terraform resource type for this Index

func (*Index) GetTerraformSchemaVersion 

func (tr *Index) GetTerraformSchemaVersion() int

GetTerraformSchemaVersion returns the associated Terraform schema version

func (*Index) GetWriteConnectionSecretToReference 

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

GetWriteConnectionSecretToReference of this Index.

func (*Index) Hub added in v0.41.2 

func (tr *Index) Hub()

Hub marks this type as a conversion hub.

func (*Index) LateInitialize 

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

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

func (*Index) SetConditions 

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

SetConditions of this Index.

func (*Index) SetDeletionPolicy 

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

SetDeletionPolicy of this Index.

func (*Index) SetManagementPolicies added in v0.35.0 

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

SetManagementPolicies of this Index.

func (*Index) SetObservation 

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

SetObservation for this Index

func (*Index) SetParameters 

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

SetParameters for this Index

func (*Index) SetProviderConfigReference 

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

SetProviderConfigReference of this Index.

func (*Index) SetPublishConnectionDetailsTo 

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

SetPublishConnectionDetailsTo of this Index.

func (*Index) SetWriteConnectionSecretToReference 

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

SetWriteConnectionSecretToReference of this Index.

type IndexInitParameters added in v0.35.0 

type IndexInitParameters struct {

	// Policy for including ancestors in the index.
	// Default value is NONE.
	// Possible values are: NONE, ALL_ANCESTORS.
	Ancestor *string `json:"ancestor,omitempty" tf:"ancestor,omitempty"`

	// The entity kind which the index applies to.
	Kind *string `json:"kind,omitempty" tf:"kind,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// An ordered list of properties to index on.
	// Structure is documented below.
	Properties []PropertiesInitParameters `json:"properties,omitempty" tf:"properties,omitempty"`
}

func (*IndexInitParameters) DeepCopy added in v0.35.0 

func (in *IndexInitParameters) DeepCopy() *IndexInitParameters

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

func (*IndexInitParameters) DeepCopyInto added in v0.35.0 

func (in *IndexInitParameters) DeepCopyInto(out *IndexInitParameters)

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

type IndexList 

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

IndexList contains a list of Indexs

func (*IndexList) DeepCopy 

func (in *IndexList) DeepCopy() *IndexList

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

func (*IndexList) DeepCopyInto 

func (in *IndexList) DeepCopyInto(out *IndexList)

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

func (*IndexList) DeepCopyObject 

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

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

func (*IndexList) GetItems 

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

GetItems of this IndexList.

type IndexObservation 

type IndexObservation struct {

	// Policy for including ancestors in the index.
	// Default value is NONE.
	// Possible values are: NONE, ALL_ANCESTORS.
	Ancestor *string `json:"ancestor,omitempty" tf:"ancestor,omitempty"`

	// an identifier for the resource with format projects/{{project}}/indexes/{{index_id}}
	ID *string `json:"id,omitempty" tf:"id,omitempty"`

	// The index id.
	IndexID *string `json:"indexId,omitempty" tf:"index_id,omitempty"`

	// The entity kind which the index applies to.
	Kind *string `json:"kind,omitempty" tf:"kind,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// An ordered list of properties to index on.
	// Structure is documented below.
	Properties []PropertiesObservation `json:"properties,omitempty" tf:"properties,omitempty"`
}

func (*IndexObservation) DeepCopy 

func (in *IndexObservation) DeepCopy() *IndexObservation

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

func (*IndexObservation) DeepCopyInto 

func (in *IndexObservation) DeepCopyInto(out *IndexObservation)

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

type IndexParameters 

type IndexParameters struct {

	// Policy for including ancestors in the index.
	// Default value is NONE.
	// Possible values are: NONE, ALL_ANCESTORS.
	// +kubebuilder:validation:Optional
	Ancestor *string `json:"ancestor,omitempty" tf:"ancestor,omitempty"`

	// The entity kind which the index applies to.
	// +kubebuilder:validation:Optional
	Kind *string `json:"kind,omitempty" tf:"kind,omitempty"`

	// The ID of the project in which the resource belongs.
	// If it is not provided, the provider project is used.
	// +kubebuilder:validation:Optional
	Project *string `json:"project,omitempty" tf:"project,omitempty"`

	// An ordered list of properties to index on.
	// Structure is documented below.
	// +kubebuilder:validation:Optional
	Properties []PropertiesParameters `json:"properties,omitempty" tf:"properties,omitempty"`
}

func (*IndexParameters) DeepCopy 

func (in *IndexParameters) DeepCopy() *IndexParameters

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

func (*IndexParameters) DeepCopyInto 

func (in *IndexParameters) DeepCopyInto(out *IndexParameters)

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

type IndexSpec 

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

IndexSpec defines the desired state of Index

func (*IndexSpec) DeepCopy 

func (in *IndexSpec) DeepCopy() *IndexSpec

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

func (*IndexSpec) DeepCopyInto 

func (in *IndexSpec) DeepCopyInto(out *IndexSpec)

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

type IndexStatus 

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

IndexStatus defines the observed state of Index.

func (*IndexStatus) DeepCopy 

func (in *IndexStatus) DeepCopy() *IndexStatus

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

func (*IndexStatus) DeepCopyInto 

func (in *IndexStatus) DeepCopyInto(out *IndexStatus)

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

type PropertiesInitParameters added in v0.35.0 

type PropertiesInitParameters struct {

	// The direction the index should optimize for sorting.
	// Possible values are: ASCENDING, DESCENDING.
	Direction *string `json:"direction,omitempty" tf:"direction,omitempty"`

	// The property name to index.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*PropertiesInitParameters) DeepCopy added in v0.35.0 

func (in *PropertiesInitParameters) DeepCopy() *PropertiesInitParameters

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

func (*PropertiesInitParameters) DeepCopyInto added in v0.35.0 

func (in *PropertiesInitParameters) DeepCopyInto(out *PropertiesInitParameters)

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

type PropertiesObservation 

type PropertiesObservation struct {

	// The direction the index should optimize for sorting.
	// Possible values are: ASCENDING, DESCENDING.
	Direction *string `json:"direction,omitempty" tf:"direction,omitempty"`

	// The property name to index.
	Name *string `json:"name,omitempty" tf:"name,omitempty"`
}

func (*PropertiesObservation) DeepCopy 

func (in *PropertiesObservation) DeepCopy() *PropertiesObservation

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

func (*PropertiesObservation) DeepCopyInto 

func (in *PropertiesObservation) DeepCopyInto(out *PropertiesObservation)

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

type PropertiesParameters 

type PropertiesParameters struct {

	// The direction the index should optimize for sorting.
	// Possible values are: ASCENDING, DESCENDING.
	// +kubebuilder:validation:Optional
	Direction *string `json:"direction" tf:"direction,omitempty"`

	// The property name to index.
	// +kubebuilder:validation:Optional
	Name *string `json:"name" tf:"name,omitempty"`
}

func (*PropertiesParameters) DeepCopy 

func (in *PropertiesParameters) DeepCopy() *PropertiesParameters

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

func (*PropertiesParameters) DeepCopyInto 

func (in *PropertiesParameters) DeepCopyInto(out *PropertiesParameters)

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.