v1alpha1

package
v0.5.0 Latest Latest
Warning

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

 Go to latest Published: May 8, 2022 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Overview

+groupName=firestore.google.kubeform.com

Index

Constants

This section is empty.

Variables

View Source 
var (
	// TODO: move SchemeBuilder with zz_generated.deepcopy.go to k8s.io/api.
	// localSchemeBuilder and AddToScheme will stay in k8s.io/kubernetes.
	SchemeBuilder runtime.SchemeBuilder

	AddToScheme = localSchemeBuilder.AddToScheme
)
View Source 
var SchemeGroupVersion = schema.GroupVersion{Group: firestore.GroupName, Version: "v1alpha1"}

Functions

func GetDecoder 

func GetDecoder() map[string]jsoniter.ValDecoder

func GetEncoder 

func GetEncoder() map[string]jsoniter.ValEncoder

func Kind 

func Kind(kind string) schema.GroupKind

Kind takes an unqualified kind and returns a Group qualified GroupKind

func Resource 

func Resource(resource string) schema.GroupResource

Resource takes an unqualified resource and returns a Group qualified GroupResource

Types

type Document 

type Document struct {
	metav1.TypeMeta   `json:",inline,omitempty"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              DocumentSpec   `json:"spec,omitempty"`
	Status            DocumentStatus `json:"status,omitempty"`
}

func (*Document) DeepCopy 

func (in *Document) DeepCopy() *Document

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

func (*Document) DeepCopyInto 

func (in *Document) DeepCopyInto(out *Document)

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

func (*Document) DeepCopyObject 

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

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

func (*Document) SetupWebhookWithManager 

func (r *Document) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Document) ValidateCreate 

func (r *Document) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Document) ValidateDelete 

func (r *Document) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Document) ValidateUpdate 

func (r *Document) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type DocumentList 

type DocumentList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is a list of Document CRD objects
	Items []Document `json:"items,omitempty"`
}

DocumentList is a list of Documents

func (*DocumentList) DeepCopy 

func (in *DocumentList) DeepCopy() *DocumentList

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

func (*DocumentList) DeepCopyInto 

func (in *DocumentList) DeepCopyInto(out *DocumentList)

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

func (*DocumentList) DeepCopyObject 

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

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

type DocumentSpec 

type DocumentSpec struct {
	State *DocumentSpecResource `json:"state,omitempty" tf:"-"`

	Resource DocumentSpecResource `json:"resource" tf:"resource"`

	UpdatePolicy base.UpdatePolicy `json:"updatePolicy,omitempty" tf:"-"`

	TerminationPolicy base.TerminationPolicy `json:"terminationPolicy,omitempty" tf:"-"`

	ProviderRef core.LocalObjectReference `json:"providerRef" tf:"-"`

	BackendRef *core.LocalObjectReference `json:"backendRef,omitempty" tf:"-"`
}

func (*DocumentSpec) DeepCopy 

func (in *DocumentSpec) DeepCopy() *DocumentSpec

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

func (*DocumentSpec) DeepCopyInto 

func (in *DocumentSpec) DeepCopyInto(out *DocumentSpec)

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

type DocumentSpecResource 

type DocumentSpecResource struct {
	Timeouts *base.ResourceTimeout `json:"timeouts,omitempty" tf:"timeouts"`

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

	// The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages.
	Collection *string `json:"collection" tf:"collection"`
	// Creation timestamp in RFC3339 format.
	// +optional
	CreateTime *string `json:"createTime,omitempty" tf:"create_time"`
	// The Firestore database id. Defaults to '"(default)"'.
	// +optional
	Database *string `json:"database,omitempty" tf:"database"`
	// The client-assigned document ID to use for this document during creation.
	DocumentID *string `json:"documentID" tf:"document_id"`
	// The document's [fields](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) formated as a json string.
	Fields *string `json:"fields" tf:"fields"`
	// A server defined name for this index. Format:
	// 'projects/{{project_id}}/databases/{{database_id}}/documents/{{path}}/{{document_id}}'
	// +optional
	Name *string `json:"name,omitempty" tf:"name"`
	// A relative path to the collection this document exists within
	// +optional
	Path *string `json:"path,omitempty" tf:"path"`
	// +optional
	Project *string `json:"project,omitempty" tf:"project"`
	// Last update timestamp in RFC3339 format.
	// +optional
	UpdateTime *string `json:"updateTime,omitempty" tf:"update_time"`
}

func (*DocumentSpecResource) DeepCopy 

func (in *DocumentSpecResource) DeepCopy() *DocumentSpecResource

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

func (*DocumentSpecResource) DeepCopyInto 

func (in *DocumentSpecResource) DeepCopyInto(out *DocumentSpecResource)

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

type DocumentStatus 

type DocumentStatus struct {
	// Resource generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// +optional
	Phase status.Status `json:"phase,omitempty"`
	// +optional
	Conditions []kmapi.Condition `json:"conditions,omitempty"`
}

func (*DocumentStatus) DeepCopy 

func (in *DocumentStatus) DeepCopy() *DocumentStatus

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

func (*DocumentStatus) DeepCopyInto 

func (in *DocumentStatus) DeepCopyInto(out *DocumentStatus)

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

type Index 

type Index struct {
	metav1.TypeMeta   `json:",inline,omitempty"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              IndexSpec   `json:"spec,omitempty"`
	Status            IndexStatus `json:"status,omitempty"`
}

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) SetupWebhookWithManager 

func (r *Index) SetupWebhookWithManager(mgr ctrl.Manager) error

func (*Index) ValidateCreate 

func (r *Index) ValidateCreate() error

ValidateCreate implements webhook.Validator so a webhook will be registered for the type

func (*Index) ValidateDelete 

func (r *Index) ValidateDelete() error

ValidateDelete implements webhook.Validator so a webhook will be registered for the type

func (*Index) ValidateUpdate 

func (r *Index) ValidateUpdate(old runtime.Object) error

ValidateUpdate implements webhook.Validator so a webhook will be registered for the type

type IndexList 

type IndexList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	// Items is a list of Index CRD objects
	Items []Index `json:"items,omitempty"`
}

IndexList is 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.

type IndexSpec 

type IndexSpec struct {
	State *IndexSpecResource `json:"state,omitempty" tf:"-"`

	Resource IndexSpecResource `json:"resource" tf:"resource"`

	UpdatePolicy base.UpdatePolicy `json:"updatePolicy,omitempty" tf:"-"`

	TerminationPolicy base.TerminationPolicy `json:"terminationPolicy,omitempty" tf:"-"`

	ProviderRef core.LocalObjectReference `json:"providerRef" tf:"-"`

	BackendRef *core.LocalObjectReference `json:"backendRef,omitempty" tf:"-"`
}

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 IndexSpecFields 

type IndexSpecFields struct {
	// Indicates that this field supports operations on arrayValues. Only one of 'order' and 'arrayConfig' can
	// be specified. Possible values: ["CONTAINS"]
	// +optional
	ArrayConfig *string `json:"arrayConfig,omitempty" tf:"array_config"`
	// Name of the field.
	// +optional
	FieldPath *string `json:"fieldPath,omitempty" tf:"field_path"`
	// Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
	// Only one of 'order' and 'arrayConfig' can be specified. Possible values: ["ASCENDING", "DESCENDING"]
	// +optional
	Order *string `json:"order,omitempty" tf:"order"`
}

func (*IndexSpecFields) DeepCopy 

func (in *IndexSpecFields) DeepCopy() *IndexSpecFields

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

func (*IndexSpecFields) DeepCopyInto 

func (in *IndexSpecFields) DeepCopyInto(out *IndexSpecFields)

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

type IndexSpecResource 

type IndexSpecResource struct {
	Timeouts *base.ResourceTimeout `json:"timeouts,omitempty" tf:"timeouts"`

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

	// The collection being indexed.
	Collection *string `json:"collection" tf:"collection"`
	// The Firestore database id. Defaults to '"(default)"'.
	// +optional
	Database *string `json:"database,omitempty" tf:"database"`
	// The fields supported by this index. The last field entry is always for
	// the field path '__name__'. If, on creation, '__name__' was not
	// specified as the last field, it will be added automatically with the
	// same direction as that of the last field defined. If the final field
	// in a composite index is not directional, the '__name__' will be
	// ordered '"ASCENDING"' (unless explicitly specified otherwise).
	// +kubebuilder:validation:MinItems=2
	Fields []IndexSpecFields `json:"fields" tf:"fields"`
	// A server defined name for this index. Format:
	// 'projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}'
	// +optional
	Name *string `json:"name,omitempty" tf:"name"`
	// +optional
	Project *string `json:"project,omitempty" tf:"project"`
	// The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"]
	// +optional
	QueryScope *string `json:"queryScope,omitempty" tf:"query_scope"`
}

func (*IndexSpecResource) DeepCopy 

func (in *IndexSpecResource) DeepCopy() *IndexSpecResource

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

func (*IndexSpecResource) DeepCopyInto 

func (in *IndexSpecResource) DeepCopyInto(out *IndexSpecResource)

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

type IndexStatus 

type IndexStatus struct {
	// Resource generation, which is updated on mutation by the API Server.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
	// +optional
	Phase status.Status `json:"phase,omitempty"`
	// +optional
	Conditions []kmapi.Condition `json:"conditions,omitempty"`
}

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.

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.