Documentation
¶
Overview ¶
Generate deepcopy object for firestore/v1beta1 API group
Package v1beta1 contains API Schema definitions for the firestore v1beta1 API group. +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=github.com/GoogleCloudPlatform/k8s-config-connector/pkg/clients/generated/pkg/apis/firestore +k8s:defaulter-gen=TypeMeta +groupName=firestore.cnrm.cloud.google.com
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // SchemeGroupVersion is the group version used to register these objects. SchemeGroupVersion = schema.GroupVersion{Group: "firestore.cnrm.cloud.google.com", Version: "v1beta1"} // SchemeBuilder is used to add go types to the GroupVersionKind scheme. SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is a global function that registers this API group & version to a scheme AddToScheme = SchemeBuilder.AddToScheme FirestoreIndexGVK = schema.GroupVersionKind{ Group: SchemeGroupVersion.Group, Version: SchemeGroupVersion.Version, Kind: reflect.TypeOf(FirestoreIndex{}).Name(), } )
Functions ¶
This section is empty.
Types ¶
type FirestoreIndex ¶
type FirestoreIndex struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec FirestoreIndexSpec `json:"spec,omitempty"`
Status FirestoreIndexStatus `json:"status,omitempty"`
}
FirestoreIndex is the Schema for the firestore API +k8s:openapi-gen=true
func (*FirestoreIndex) DeepCopy ¶
func (in *FirestoreIndex) DeepCopy() *FirestoreIndex
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirestoreIndex.
func (*FirestoreIndex) DeepCopyInto ¶
func (in *FirestoreIndex) DeepCopyInto(out *FirestoreIndex)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FirestoreIndex) DeepCopyObject ¶
func (in *FirestoreIndex) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type FirestoreIndexList ¶
type FirestoreIndexList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
Items []FirestoreIndex `json:"items"`
}
FirestoreIndexList contains a list of FirestoreIndex
func (*FirestoreIndexList) DeepCopy ¶
func (in *FirestoreIndexList) DeepCopy() *FirestoreIndexList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirestoreIndexList.
func (*FirestoreIndexList) DeepCopyInto ¶
func (in *FirestoreIndexList) DeepCopyInto(out *FirestoreIndexList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*FirestoreIndexList) DeepCopyObject ¶
func (in *FirestoreIndexList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type FirestoreIndexSpec ¶
type FirestoreIndexSpec struct {
/* Immutable. The collection being indexed. */
Collection string `json:"collection"`
/* Immutable. The Firestore database id. Defaults to '"(default)"'. */
// +optional
Database *string `json:"database,omitempty"`
/* Immutable. 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). */
Fields []IndexFields `json:"fields"`
/* Immutable. The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"]. */
// +optional
QueryScope *string `json:"queryScope,omitempty"`
}
func (*FirestoreIndexSpec) DeepCopy ¶
func (in *FirestoreIndexSpec) DeepCopy() *FirestoreIndexSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirestoreIndexSpec.
func (*FirestoreIndexSpec) DeepCopyInto ¶
func (in *FirestoreIndexSpec) DeepCopyInto(out *FirestoreIndexSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FirestoreIndexStatus ¶
type FirestoreIndexStatus struct {
/* Conditions represent the latest available observations of the
FirestoreIndex's current state. */
Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
/* A server defined name for this index. Format:
'projects/{{project}}/databases/{{database}}/collectionGroups/{{collection}}/indexes/{{server_generated_id}}'. */
// +optional
Name *string `json:"name,omitempty"`
/* ObservedGeneration is the generation of the resource that was most recently observed by the Config Connector controller. If this is equal to metadata.generation, then that means that the current reported status reflects the most recent desired state of the resource. */
// +optional
ObservedGeneration *int `json:"observedGeneration,omitempty"`
}
func (*FirestoreIndexStatus) DeepCopy ¶
func (in *FirestoreIndexStatus) DeepCopy() *FirestoreIndexStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirestoreIndexStatus.
func (*FirestoreIndexStatus) DeepCopyInto ¶
func (in *FirestoreIndexStatus) DeepCopyInto(out *FirestoreIndexStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type IndexFields ¶
type IndexFields struct {
/* Immutable. 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"`
/* Immutable. Name of the field. */
// +optional
FieldPath *string `json:"fieldPath,omitempty"`
/* Immutable. 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"`
}
func (*IndexFields) DeepCopy ¶
func (in *IndexFields) DeepCopy() *IndexFields
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IndexFields.
func (*IndexFields) DeepCopyInto ¶
func (in *IndexFields) DeepCopyInto(out *IndexFields)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.