Documentation
¶
Overview ¶
+kubebuilder:object:generate=true +groupName=firestore.gcp.jet.crossplane.io +versionName=v1alpha1
Index ¶
- Constants
- Variables
- type Document
- func (in *Document) DeepCopy() *Document
- func (in *Document) DeepCopyInto(out *Document)
- func (in *Document) DeepCopyObject() runtime.Object
- func (mg *Document) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Document) GetConnectionDetailsMapping() map[string]string
- func (mg *Document) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Document) GetID() string
- func (tr *Document) GetObservation() (map[string]interface{}, error)
- func (tr *Document) GetParameters() (map[string]interface{}, error)
- func (mg *Document) GetProviderConfigReference() *xpv1.Reference
- func (mg *Document) GetProviderReference() *xpv1.Reference
- func (mg *Document) GetTerraformResourceType() string
- func (tr *Document) GetTerraformSchemaVersion() int
- func (mg *Document) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Document) LateInitialize(attrs []byte) (bool, error)
- func (mg *Document) SetConditions(c ...xpv1.Condition)
- func (mg *Document) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (tr *Document) SetObservation(obs map[string]interface{}) error
- func (tr *Document) SetParameters(params map[string]interface{}) error
- func (mg *Document) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Document) SetProviderReference(r *xpv1.Reference)
- func (mg *Document) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type DocumentList
- type DocumentObservation
- type DocumentParameters
- type DocumentSpec
- type DocumentStatus
- type FieldsObservation
- type FieldsParameters
- type Index
- func (in *Index) DeepCopy() *Index
- func (in *Index) DeepCopyInto(out *Index)
- func (in *Index) DeepCopyObject() runtime.Object
- func (mg *Index) GetCondition(ct xpv1.ConditionType) xpv1.Condition
- func (tr *Index) GetConnectionDetailsMapping() map[string]string
- func (mg *Index) GetDeletionPolicy() xpv1.DeletionPolicy
- func (tr *Index) GetID() string
- func (tr *Index) GetObservation() (map[string]interface{}, error)
- func (tr *Index) GetParameters() (map[string]interface{}, error)
- func (mg *Index) GetProviderConfigReference() *xpv1.Reference
- func (mg *Index) GetProviderReference() *xpv1.Reference
- func (mg *Index) GetTerraformResourceType() string
- func (tr *Index) GetTerraformSchemaVersion() int
- func (mg *Index) GetWriteConnectionSecretToReference() *xpv1.SecretReference
- func (tr *Index) LateInitialize(attrs []byte) (bool, error)
- func (mg *Index) SetConditions(c ...xpv1.Condition)
- func (mg *Index) SetDeletionPolicy(r xpv1.DeletionPolicy)
- func (tr *Index) SetObservation(obs map[string]interface{}) error
- func (tr *Index) SetParameters(params map[string]interface{}) error
- func (mg *Index) SetProviderConfigReference(r *xpv1.Reference)
- func (mg *Index) SetProviderReference(r *xpv1.Reference)
- func (mg *Index) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
- type IndexList
- type IndexObservation
- type IndexParameters
- type IndexSpec
- type IndexStatus
Constants ¶
const ( CRDGroup = "firestore.gcp.jet.crossplane.io" CRDVersion = "v1alpha1" )
Package type metadata.
Variables ¶
var ( Document_Kind = "Document" Document_GroupKind = schema.GroupKind{Group: CRDGroup, Kind: Document_Kind}.String() Document_KindAPIVersion = Document_Kind + "." + CRDGroupVersion.String() Document_GroupVersionKind = CRDGroupVersion.WithKind(Document_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 )
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 Document ¶
type Document struct { metav1.TypeMeta `json:",inline"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec DocumentSpec `json:"spec"` Status DocumentStatus `json:"status,omitempty"` }
Document is the Schema for the Documents API +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,gcpjet}
func (*Document) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Document.
func (*Document) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Document) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
func (*Document) GetCondition ¶
func (mg *Document) GetCondition(ct xpv1.ConditionType) xpv1.Condition
GetCondition of this Document.
func (*Document) GetConnectionDetailsMapping ¶
GetConnectionDetailsMapping for this Document
func (*Document) GetDeletionPolicy ¶
func (mg *Document) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Document.
func (*Document) GetObservation ¶
GetObservation of this Document
func (*Document) GetParameters ¶
GetParameters of this Document
func (*Document) GetProviderConfigReference ¶
GetProviderConfigReference of this Document.
func (*Document) GetProviderReference ¶
GetProviderReference of this Document. Deprecated: Use GetProviderConfigReference.
func (*Document) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Document
func (*Document) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Document) GetWriteConnectionSecretToReference ¶
func (mg *Document) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Document.
func (*Document) LateInitialize ¶
LateInitialize this Document using its observed tfState. returns True if there are any spec changes for the resource.
func (*Document) SetConditions ¶
SetConditions of this Document.
func (*Document) SetDeletionPolicy ¶
func (mg *Document) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Document.
func (*Document) SetObservation ¶
SetObservation for this Document
func (*Document) SetParameters ¶
SetParameters for this Document
func (*Document) SetProviderConfigReference ¶
SetProviderConfigReference of this Document.
func (*Document) SetProviderReference ¶
SetProviderReference of this Document. Deprecated: Use SetProviderConfigReference.
func (*Document) SetWriteConnectionSecretToReference ¶
func (mg *Document) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Document.
type DocumentList ¶
type DocumentList struct { metav1.TypeMeta `json:",inline"` metav1.ListMeta `json:"metadata,omitempty"` Items []Document `json:"items"` }
DocumentList contains 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.
func (*DocumentList) GetItems ¶
func (l *DocumentList) GetItems() []resource.Managed
GetItems of this DocumentList.
type DocumentObservation ¶
type DocumentObservation struct { CreateTime *string `json:"createTime,omitempty" tf:"create_time,omitempty"` ID *string `json:"id,omitempty" tf:"id,omitempty"` Name *string `json:"name,omitempty" tf:"name,omitempty"` Path *string `json:"path,omitempty" tf:"path,omitempty"` UpdateTime *string `json:"updateTime,omitempty" tf:"update_time,omitempty"` }
func (*DocumentObservation) DeepCopy ¶
func (in *DocumentObservation) DeepCopy() *DocumentObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocumentObservation.
func (*DocumentObservation) DeepCopyInto ¶
func (in *DocumentObservation) DeepCopyInto(out *DocumentObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DocumentParameters ¶
type DocumentParameters struct { // The collection ID, relative to database. For example: chatrooms or chatrooms/my-document/private-messages. // +kubebuilder:validation:Required Collection *string `json:"collection" tf:"collection,omitempty"` // The Firestore database id. Defaults to '"(default)"'. // +kubebuilder:validation:Optional Database *string `json:"database,omitempty" tf:"database,omitempty"` // The client-assigned document ID to use for this document during creation. // +kubebuilder:validation:Required DocumentID *string `json:"documentId" tf:"document_id,omitempty"` // The document's [fields](https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases.documents) formated as a json string. // +kubebuilder:validation:Required Fields *string `json:"fields" tf:"fields,omitempty"` // +kubebuilder:validation:Optional Project *string `json:"project,omitempty" tf:"project,omitempty"` }
func (*DocumentParameters) DeepCopy ¶
func (in *DocumentParameters) DeepCopy() *DocumentParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new DocumentParameters.
func (*DocumentParameters) DeepCopyInto ¶
func (in *DocumentParameters) DeepCopyInto(out *DocumentParameters)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type DocumentSpec ¶
type DocumentSpec struct { v1.ResourceSpec `json:",inline"` ForProvider DocumentParameters `json:"forProvider"` }
DocumentSpec defines the desired state of Document
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 DocumentStatus ¶
type DocumentStatus struct { v1.ResourceStatus `json:",inline"` AtProvider DocumentObservation `json:"atProvider,omitempty"` }
DocumentStatus defines the observed state of Document.
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 FieldsObservation ¶
type FieldsObservation struct { }
func (*FieldsObservation) DeepCopy ¶
func (in *FieldsObservation) DeepCopy() *FieldsObservation
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FieldsObservation.
func (*FieldsObservation) DeepCopyInto ¶
func (in *FieldsObservation) DeepCopyInto(out *FieldsObservation)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type FieldsParameters ¶
type FieldsParameters struct { // Indicates that this field supports operations on arrayValues. Only one of 'order' and 'arrayConfig' can // be specified. Possible values: ["CONTAINS"] // +kubebuilder:validation:Optional ArrayConfig *string `json:"arrayConfig,omitempty" tf:"array_config,omitempty"` // Name of the field. // +kubebuilder:validation:Optional FieldPath *string `json:"fieldPath,omitempty" tf:"field_path,omitempty"` // 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"] // +kubebuilder:validation:Optional Order *string `json:"order,omitempty" tf:"order,omitempty"` }
func (*FieldsParameters) DeepCopy ¶
func (in *FieldsParameters) DeepCopy() *FieldsParameters
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FieldsParameters.
func (*FieldsParameters) DeepCopyInto ¶
func (in *FieldsParameters) DeepCopyInto(out *FieldsParameters)
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"` metav1.ObjectMeta `json:"metadata,omitempty"` Spec IndexSpec `json:"spec"` Status IndexStatus `json:"status,omitempty"` }
Index is the Schema for the Indexs API +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,gcpjet}
func (*Index) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Index.
func (*Index) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*Index) DeepCopyObject ¶
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 ¶
GetConnectionDetailsMapping for this Index
func (*Index) GetDeletionPolicy ¶
func (mg *Index) GetDeletionPolicy() xpv1.DeletionPolicy
GetDeletionPolicy of this Index.
func (*Index) GetObservation ¶
GetObservation of this Index
func (*Index) GetParameters ¶
GetParameters of this Index
func (*Index) GetProviderConfigReference ¶
GetProviderConfigReference of this Index.
func (*Index) GetProviderReference ¶
GetProviderReference of this Index. Deprecated: Use GetProviderConfigReference.
func (*Index) GetTerraformResourceType ¶
GetTerraformResourceType returns Terraform resource type for this Index
func (*Index) GetTerraformSchemaVersion ¶
GetTerraformSchemaVersion returns the associated Terraform schema version
func (*Index) GetWriteConnectionSecretToReference ¶
func (mg *Index) GetWriteConnectionSecretToReference() *xpv1.SecretReference
GetWriteConnectionSecretToReference of this Index.
func (*Index) LateInitialize ¶
LateInitialize this Index using its observed tfState. returns True if there are any spec changes for the resource.
func (*Index) SetConditions ¶
SetConditions of this Index.
func (*Index) SetDeletionPolicy ¶
func (mg *Index) SetDeletionPolicy(r xpv1.DeletionPolicy)
SetDeletionPolicy of this Index.
func (*Index) SetObservation ¶
SetObservation for this Index
func (*Index) SetParameters ¶
SetParameters for this Index
func (*Index) SetProviderConfigReference ¶
SetProviderConfigReference of this Index.
func (*Index) SetProviderReference ¶
SetProviderReference of this Index. Deprecated: Use SetProviderConfigReference.
func (*Index) SetWriteConnectionSecretToReference ¶
func (mg *Index) SetWriteConnectionSecretToReference(r *xpv1.SecretReference)
SetWriteConnectionSecretToReference of this Index.
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 ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IndexList.
func (*IndexList) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*IndexList) DeepCopyObject ¶
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type IndexObservation ¶
type IndexObservation struct { ID *string `json:"id,omitempty" tf:"id,omitempty"` Name *string `json:"name,omitempty" tf:"name,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 { // The collection being indexed. // +kubebuilder:validation:Required Collection *string `json:"collection" tf:"collection,omitempty"` // The Firestore database id. Defaults to '"(default)"'. // +kubebuilder:validation:Optional Database *string `json:"database,omitempty" tf:"database,omitempty"` // 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:Required Fields []FieldsParameters `json:"fields" tf:"fields,omitempty"` // +kubebuilder:validation:Optional Project *string `json:"project,omitempty" tf:"project,omitempty"` // The scope at which a query is run. Default value: "COLLECTION" Possible values: ["COLLECTION", "COLLECTION_GROUP"] // +kubebuilder:validation:Optional QueryScope *string `json:"queryScope,omitempty" tf:"query_scope,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"` }
IndexSpec defines the desired state of Index
func (*IndexSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IndexSpec.
func (*IndexSpec) DeepCopyInto ¶
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.