v1alpha1

Documentation

Overview

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

Index

• Variables
• type DatabaseObservedStateStatus
  • func (in *DatabaseObservedStateStatus) DeepCopy() *DatabaseObservedStateStatus
  • func (in *DatabaseObservedStateStatus) DeepCopyInto(out *DatabaseObservedStateStatus)
• type FirestoreDatabase
  • func (in *FirestoreDatabase) DeepCopy() *FirestoreDatabase
  • func (in *FirestoreDatabase) DeepCopyInto(out *FirestoreDatabase)
  • func (in *FirestoreDatabase) DeepCopyObject() runtime.Object
• type FirestoreDatabaseList
  • func (in *FirestoreDatabaseList) DeepCopy() *FirestoreDatabaseList
  • func (in *FirestoreDatabaseList) DeepCopyInto(out *FirestoreDatabaseList)
  • func (in *FirestoreDatabaseList) DeepCopyObject() runtime.Object
• type FirestoreDatabaseSpec
  • func (in *FirestoreDatabaseSpec) DeepCopy() *FirestoreDatabaseSpec
  • func (in *FirestoreDatabaseSpec) DeepCopyInto(out *FirestoreDatabaseSpec)
• type FirestoreDatabaseStatus
  • func (in *FirestoreDatabaseStatus) DeepCopy() *FirestoreDatabaseStatus
  • func (in *FirestoreDatabaseStatus) DeepCopyInto(out *FirestoreDatabaseStatus)

Variables

var (
	// SchemeGroupVersion is the group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: "firestore.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

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

Types

type DatabaseObservedStateStatus

type DatabaseObservedStateStatus struct {
	/* Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time. */
	// +optional
	CreateTime *string `json:"createTime,omitempty"`

	/* Output only. The earliest timestamp at which older versions of the data can
	be read from the database. See [version_retention_period] above; this field
	is populated with `now - version_retention_period`.

	This value is continuously updated, and becomes stale the moment it is
	queried. If you are using this value to recover data, make sure to account
	for the time from the moment when the value is queried to the moment when
	you initiate the recovery. */
	// +optional
	EarliestVersionTime *string `json:"earliestVersionTime,omitempty"`

	/* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */
	// +optional
	Etag *string `json:"etag,omitempty"`

	/* Output only. The key_prefix for this database. This key_prefix is used, in
	combination with the project id ("<key prefix>~<project id>") to construct
	the application id that is returned from the Cloud Datastore APIs in Google
	App Engine first generation runtimes.

	This value may be empty in which case the appid to use for URL-encoded keys
	is the project_id (eg: foo instead of v~foo). */
	// +optional
	KeyPrefix *string `json:"keyPrefix,omitempty"`

	/* Output only. The system-generated UUID4 for this Database. */
	// +optional
	Uid *string `json:"uid,omitempty"`

	/* Output only. The timestamp at which this database was most recently updated. Note this only includes updates to the database resource and not data contained by the database. */
	// +optional
	UpdateTime *string `json:"updateTime,omitempty"`

	/* Output only. The period during which past versions of data are retained in
	the database.

	Any [read][google.firestore.v1.GetDocumentRequest.read_time]
	or [query][google.firestore.v1.ListDocumentsRequest.read_time] can specify
	a `read_time` within this window, and will read the state of the database
	at that time.

	If the PITR feature is enabled, the retention period is 7 days. Otherwise,
	the retention period is 1 hour. */
	// +optional
	VersionRetentionPeriod *string `json:"versionRetentionPeriod,omitempty"`
}

func (*DatabaseObservedStateStatus) DeepCopy

func (in *DatabaseObservedStateStatus) DeepCopy() *DatabaseObservedStateStatus

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

func (*DatabaseObservedStateStatus) DeepCopyInto

func (in *DatabaseObservedStateStatus) DeepCopyInto(out *DatabaseObservedStateStatus)

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

type FirestoreDatabase

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

	Spec   FirestoreDatabaseSpec   `json:"spec,omitempty"`
	Status FirestoreDatabaseStatus `json:"status,omitempty"`
}

FirestoreDatabase is the Schema for the firestore API +k8s:openapi-gen=true

func (*FirestoreDatabase) DeepCopy

func (in *FirestoreDatabase) DeepCopy() *FirestoreDatabase

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

func (*FirestoreDatabase) DeepCopyInto

func (in *FirestoreDatabase) DeepCopyInto(out *FirestoreDatabase)

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

func (*FirestoreDatabase) DeepCopyObject

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

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

type FirestoreDatabaseList

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

FirestoreDatabaseList contains a list of FirestoreDatabase

func (*FirestoreDatabaseList) DeepCopy

func (in *FirestoreDatabaseList) DeepCopy() *FirestoreDatabaseList

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

func (*FirestoreDatabaseList) DeepCopyInto

func (in *FirestoreDatabaseList) DeepCopyInto(out *FirestoreDatabaseList)

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

func (*FirestoreDatabaseList) DeepCopyObject

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

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

type FirestoreDatabaseSpec

type FirestoreDatabaseSpec struct {
	/* The concurrency control mode to use for this database. See https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases#concurrencymode for more info. */
	// +optional
	ConcurrencyMode *string `json:"concurrencyMode,omitempty"`

	/* The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
	// +optional
	LocationID *string `json:"locationID,omitempty"`

	/* Whether to enable the PITR feature on this database. See https://cloud.google.com/firestore/docs/reference/rest/v1/projects.databases#pointintimerecoveryenablement for more info. */
	// +optional
	PointInTimeRecoveryEnablement *string `json:"pointInTimeRecoveryEnablement,omitempty"`

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

	/* The FirestoreDatabase name. If not given, the metadata.name will be used. */
	// +optional
	ResourceID *string `json:"resourceID,omitempty"`
}

func (*FirestoreDatabaseSpec) DeepCopy

func (in *FirestoreDatabaseSpec) DeepCopy() *FirestoreDatabaseSpec

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

func (*FirestoreDatabaseSpec) DeepCopyInto

func (in *FirestoreDatabaseSpec) DeepCopyInto(out *FirestoreDatabaseSpec)

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

type FirestoreDatabaseStatus

type FirestoreDatabaseStatus struct {
	/* Conditions represent the latest available observations of the
	   FirestoreDatabase's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* A unique specifier for the FirestoreDatabase resource in GCP. */
	// +optional
	ExternalRef *string `json:"externalRef,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"`

	/* ObservedState is the state of the resource as most recently observed in GCP. */
	// +optional
	ObservedState *DatabaseObservedStateStatus `json:"observedState,omitempty"`
}

func (*FirestoreDatabaseStatus) DeepCopy

func (in *FirestoreDatabaseStatus) DeepCopy() *FirestoreDatabaseStatus

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

func (*FirestoreDatabaseStatus) DeepCopyInto

func (in *FirestoreDatabaseStatus) DeepCopyInto(out *FirestoreDatabaseStatus)

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