v1alpha1

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the firebasedatabase v1alpha1 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/firebasedatabase +k8s:defaulter-gen=TypeMeta +groupName=firebasedatabase.cnrm.cloud.google.com

Index

• Variables
• type FirebaseDatabaseInstance
  • func (in *FirebaseDatabaseInstance) DeepCopy() *FirebaseDatabaseInstance
  • func (in *FirebaseDatabaseInstance) DeepCopyInto(out *FirebaseDatabaseInstance)
  • func (in *FirebaseDatabaseInstance) DeepCopyObject() runtime.Object
• type FirebaseDatabaseInstanceList
  • func (in *FirebaseDatabaseInstanceList) DeepCopy() *FirebaseDatabaseInstanceList
  • func (in *FirebaseDatabaseInstanceList) DeepCopyInto(out *FirebaseDatabaseInstanceList)
  • func (in *FirebaseDatabaseInstanceList) DeepCopyObject() runtime.Object
• type FirebaseDatabaseInstanceSpec
  • func (in *FirebaseDatabaseInstanceSpec) DeepCopy() *FirebaseDatabaseInstanceSpec
  • func (in *FirebaseDatabaseInstanceSpec) DeepCopyInto(out *FirebaseDatabaseInstanceSpec)
• type FirebaseDatabaseInstanceStatus
  • func (in *FirebaseDatabaseInstanceStatus) DeepCopy() *FirebaseDatabaseInstanceStatus
  • func (in *FirebaseDatabaseInstanceStatus) DeepCopyInto(out *FirebaseDatabaseInstanceStatus)

Variables

var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "firebasedatabase.cnrm.cloud.google.com", Version: "v1alpha1"}

	// 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

	FirebaseDatabaseInstanceGVK = schema.GroupVersionKind{
		Group:   SchemeGroupVersion.Group,
		Version: SchemeGroupVersion.Version,
		Kind:    reflect.TypeOf(FirebaseDatabaseInstance{}).Name(),
	}
)

Types

type FirebaseDatabaseInstance

type FirebaseDatabaseInstance struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   FirebaseDatabaseInstanceSpec   `json:"spec,omitempty"`
	Status FirebaseDatabaseInstanceStatus `json:"status,omitempty"`
}

FirebaseDatabaseInstance is the Schema for the firebasedatabase API +k8s:openapi-gen=true

func (*FirebaseDatabaseInstance) DeepCopy

func (in *FirebaseDatabaseInstance) DeepCopy() *FirebaseDatabaseInstance

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

func (*FirebaseDatabaseInstance) DeepCopyInto

func (in *FirebaseDatabaseInstance) DeepCopyInto(out *FirebaseDatabaseInstance)

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

func (*FirebaseDatabaseInstance) DeepCopyObject

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

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

type FirebaseDatabaseInstanceList

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

FirebaseDatabaseInstanceList contains a list of FirebaseDatabaseInstance

func (*FirebaseDatabaseInstanceList) DeepCopy

func (in *FirebaseDatabaseInstanceList) DeepCopy() *FirebaseDatabaseInstanceList

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

func (*FirebaseDatabaseInstanceList) DeepCopyInto

func (in *FirebaseDatabaseInstanceList) DeepCopyInto(out *FirebaseDatabaseInstanceList)

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

func (*FirebaseDatabaseInstanceList) DeepCopyObject

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

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

type FirebaseDatabaseInstanceSpec

type FirebaseDatabaseInstanceSpec struct {
	/* The intended database state. */
	// +optional
	DesiredState *string `json:"desiredState,omitempty"`

	/* The project that this resource belongs to. */
	ProjectRef v1alpha1.ResourceRef `json:"projectRef"`

	/* Immutable. A reference to the region where the Firebase Realtime database resides.
	Check all [available regions](https://firebase.google.com/docs/projects/locations#rtdb-locations). */
	Region string `json:"region"`

	/* Immutable. Optional. The instanceId of the resource. Used for creation and acquisition. When unset, the value of `metadata.name` is used as the default. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`

	/* Immutable. The database type.
	Each project can create one default Firebase Realtime Database, which cannot be deleted once created.
	Creating user Databases is only available for projects on the Blaze plan.
	Projects can be upgraded using the Cloud Billing API https://cloud.google.com/billing/reference/rest/v1/projects/updateBillingInfo. Default value: "USER_DATABASE" Possible values: ["DEFAULT_DATABASE", "USER_DATABASE"]. */
	// +optional
	Type *string `json:"type,omitempty"`
}

func (*FirebaseDatabaseInstanceSpec) DeepCopy

func (in *FirebaseDatabaseInstanceSpec) DeepCopy() *FirebaseDatabaseInstanceSpec

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

func (*FirebaseDatabaseInstanceSpec) DeepCopyInto

func (in *FirebaseDatabaseInstanceSpec) DeepCopyInto(out *FirebaseDatabaseInstanceSpec)

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

type FirebaseDatabaseInstanceStatus

type FirebaseDatabaseInstanceStatus struct {
	/* Conditions represent the latest available observations of the
	   FirebaseDatabaseInstance's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The database URL in the form of https://{instance-id}.firebaseio.com for us-central1 instances
	or https://{instance-id}.{region}.firebasedatabase.app in other regions. */
	// +optional
	DatabaseUrl *string `json:"databaseUrl,omitempty"`

	/* The fully-qualified resource name of the Firebase Realtime Database, in the
	format: projects/PROJECT_NUMBER/locations/REGION_IDENTIFIER/instances/INSTANCE_ID
	PROJECT_NUMBER: The Firebase project's ['ProjectNumber'](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject.FIELDS.project_number)
	Learn more about using project identifiers in Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510). */
	// +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 *int64 `json:"observedGeneration,omitempty"`

	/* The current database state. Set desired_state to :DISABLED to disable the database and :ACTIVE to reenable the database. */
	// +optional
	State *string `json:"state,omitempty"`
}

func (*FirebaseDatabaseInstanceStatus) DeepCopy

func (in *FirebaseDatabaseInstanceStatus) DeepCopy() *FirebaseDatabaseInstanceStatus

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

func (*FirebaseDatabaseInstanceStatus) DeepCopyInto

func (in *FirebaseDatabaseInstanceStatus) DeepCopyInto(out *FirebaseDatabaseInstanceStatus)

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