v1alpha1

package
v1.127.0 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

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

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

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

Functions

This section is empty.

Types

type CloudIOTDevice

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

	Spec   CloudIOTDeviceSpec   `json:"spec,omitempty"`
	Status CloudIOTDeviceStatus `json:"status,omitempty"`
}

CloudIOTDevice is the Schema for the cloudiot API +k8s:openapi-gen=true

func (*CloudIOTDevice) DeepCopy

func (in *CloudIOTDevice) DeepCopy() *CloudIOTDevice

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

func (*CloudIOTDevice) DeepCopyInto

func (in *CloudIOTDevice) DeepCopyInto(out *CloudIOTDevice)

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

func (*CloudIOTDevice) DeepCopyObject

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

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

type CloudIOTDeviceList

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

CloudIOTDeviceList contains a list of CloudIOTDevice

func (*CloudIOTDeviceList) DeepCopy

func (in *CloudIOTDeviceList) DeepCopy() *CloudIOTDeviceList

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

func (*CloudIOTDeviceList) DeepCopyInto

func (in *CloudIOTDeviceList) DeepCopyInto(out *CloudIOTDeviceList)

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

func (*CloudIOTDeviceList) DeepCopyObject

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

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

type CloudIOTDeviceRegistry added in v1.109.0

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

	Spec   CloudIOTDeviceRegistrySpec   `json:"spec,omitempty"`
	Status CloudIOTDeviceRegistryStatus `json:"status,omitempty"`
}

CloudIOTDeviceRegistry is the Schema for the cloudiot API +k8s:openapi-gen=true

func (*CloudIOTDeviceRegistry) DeepCopy added in v1.109.0

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

func (*CloudIOTDeviceRegistry) DeepCopyInto added in v1.109.0

func (in *CloudIOTDeviceRegistry) DeepCopyInto(out *CloudIOTDeviceRegistry)

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

func (*CloudIOTDeviceRegistry) DeepCopyObject added in v1.109.0

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

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

type CloudIOTDeviceRegistryList added in v1.109.0

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

CloudIOTDeviceRegistryList contains a list of CloudIOTDeviceRegistry

func (*CloudIOTDeviceRegistryList) DeepCopy added in v1.109.0

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

func (*CloudIOTDeviceRegistryList) DeepCopyInto added in v1.109.0

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

func (*CloudIOTDeviceRegistryList) DeepCopyObject added in v1.109.0

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

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

type CloudIOTDeviceRegistrySpec added in v1.109.0

type CloudIOTDeviceRegistrySpec struct {
	/* List of public key certificates to authenticate devices. */
	// +optional
	Credentials []DeviceregistryCredentials `json:"credentials,omitempty"`

	/* List of configurations for event notifications, such as PubSub topics
	to publish device events to. */
	// +optional
	EventNotificationConfigs []DeviceregistryEventNotificationConfigs `json:"eventNotificationConfigs,omitempty"`

	/* Activate or deactivate HTTP. */
	// +optional
	HttpConfig *DeviceregistryHttpConfig `json:"httpConfig,omitempty"`

	/* The default logging verbosity for activity from devices in this
	registry. Specifies which events should be written to logs. For
	example, if the LogLevel is ERROR, only events that terminate in
	errors will be logged. LogLevel is inclusive; enabling INFO logging
	will also enable ERROR logging. Default value: "NONE" Possible values: ["NONE", "ERROR", "INFO", "DEBUG"]. */
	// +optional
	LogLevel *string `json:"logLevel,omitempty"`

	/* Activate or deactivate MQTT. */
	// +optional
	MqttConfig *DeviceregistryMqttConfig `json:"mqttConfig,omitempty"`

	/* Immutable. */
	// +optional
	Project *string `json:"project,omitempty"`

	/* Immutable. The region in which the created registry should reside.
	If it is not provided, the provider region is used. */
	Region string `json:"region"`

	/* Immutable. Optional. The name 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"`

	/* A PubSub topic to publish device state updates. */
	// +optional
	StateNotificationConfig *DeviceregistryStateNotificationConfig `json:"stateNotificationConfig,omitempty"`
}

func (*CloudIOTDeviceRegistrySpec) DeepCopy added in v1.109.0

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

func (*CloudIOTDeviceRegistrySpec) DeepCopyInto added in v1.109.0

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

type CloudIOTDeviceRegistryStatus added in v1.109.0

type CloudIOTDeviceRegistryStatus struct {
	/* Conditions represent the latest available observations of the
	   CloudIOTDeviceRegistry's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,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"`
}

func (*CloudIOTDeviceRegistryStatus) DeepCopy added in v1.109.0

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

func (*CloudIOTDeviceRegistryStatus) DeepCopyInto added in v1.109.0

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

type CloudIOTDeviceSpec

type CloudIOTDeviceSpec struct {
	/* If a device is blocked, connections or requests from this device will fail. */
	// +optional
	Blocked *bool `json:"blocked,omitempty"`

	/* The credentials used to authenticate this device. */
	// +optional
	Credentials []DeviceCredentials `json:"credentials,omitempty"`

	/* Gateway-related configuration and state. */
	// +optional
	GatewayConfig *DeviceGatewayConfig `json:"gatewayConfig,omitempty"`

	/* The logging verbosity for device activity. Possible values: ["NONE", "ERROR", "INFO", "DEBUG"]. */
	// +optional
	LogLevel *string `json:"logLevel,omitempty"`

	/* The metadata key-value pairs assigned to the device. */
	// +optional
	Metadata map[string]string `json:"metadata,omitempty"`

	/* Immutable. The name of the device registry where this device should be created. */
	Registry string `json:"registry"`

	/* Immutable. Optional. The name 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"`
}

func (*CloudIOTDeviceSpec) DeepCopy

func (in *CloudIOTDeviceSpec) DeepCopy() *CloudIOTDeviceSpec

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

func (*CloudIOTDeviceSpec) DeepCopyInto

func (in *CloudIOTDeviceSpec) DeepCopyInto(out *CloudIOTDeviceSpec)

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

type CloudIOTDeviceStatus

type CloudIOTDeviceStatus struct {
	/* Conditions represent the latest available observations of the
	   CloudIOTDevice's current state. */
	Conditions []v1alpha1.Condition `json:"conditions,omitempty"`
	/* The most recent device configuration, which is eventually sent from Cloud IoT Core to the device. */
	// +optional
	Config []DeviceConfigStatus `json:"config,omitempty"`

	/* The last time a cloud-to-device config version acknowledgment was received from the device. */
	// +optional
	LastConfigAckTime *string `json:"lastConfigAckTime,omitempty"`

	/* The last time a cloud-to-device config version was sent to the device. */
	// +optional
	LastConfigSendTime *string `json:"lastConfigSendTime,omitempty"`

	/* The error message of the most recent error, such as a failure to publish to Cloud Pub/Sub. */
	// +optional
	LastErrorStatus []DeviceLastErrorStatusStatus `json:"lastErrorStatus,omitempty"`

	/* The time the most recent error occurred, such as a failure to publish to Cloud Pub/Sub. */
	// +optional
	LastErrorTime *string `json:"lastErrorTime,omitempty"`

	/* The last time a telemetry event was received. */
	// +optional
	LastEventTime *string `json:"lastEventTime,omitempty"`

	/* The last time an MQTT PINGREQ was received. */
	// +optional
	LastHeartbeatTime *string `json:"lastHeartbeatTime,omitempty"`

	/* The last time a state event was received. */
	// +optional
	LastStateTime *string `json:"lastStateTime,omitempty"`

	/* A server-defined unique numeric ID for the device.
	This is a more compact way to identify devices, and it is globally unique. */
	// +optional
	NumId *string `json:"numId,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 state most recently received from the device. */
	// +optional
	State []DeviceStateStatus `json:"state,omitempty"`
}

func (*CloudIOTDeviceStatus) DeepCopy

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

func (*CloudIOTDeviceStatus) DeepCopyInto

func (in *CloudIOTDeviceStatus) DeepCopyInto(out *CloudIOTDeviceStatus)

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

type DeviceConfigStatus

type DeviceConfigStatus struct {
	/* The device configuration data. */
	// +optional
	BinaryData *string `json:"binaryData,omitempty"`

	/* The time at which this configuration version was updated in Cloud IoT Core. */
	// +optional
	CloudUpdateTime *string `json:"cloudUpdateTime,omitempty"`

	/* The time at which Cloud IoT Core received the acknowledgment from the device,
	indicating that the device has received this configuration version. */
	// +optional
	DeviceAckTime *string `json:"deviceAckTime,omitempty"`

	/* The version of this update. */
	// +optional
	Version *string `json:"version,omitempty"`
}

func (*DeviceConfigStatus) DeepCopy

func (in *DeviceConfigStatus) DeepCopy() *DeviceConfigStatus

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

func (*DeviceConfigStatus) DeepCopyInto

func (in *DeviceConfigStatus) DeepCopyInto(out *DeviceConfigStatus)

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

type DeviceCredentials

type DeviceCredentials struct {
	/* The time at which this credential becomes invalid. */
	// +optional
	ExpirationTime *string `json:"expirationTime,omitempty"`

	/* A public key used to verify the signature of JSON Web Tokens (JWTs). */
	PublicKey DevicePublicKey `json:"publicKey"`
}

func (*DeviceCredentials) DeepCopy

func (in *DeviceCredentials) DeepCopy() *DeviceCredentials

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

func (*DeviceCredentials) DeepCopyInto

func (in *DeviceCredentials) DeepCopyInto(out *DeviceCredentials)

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

type DeviceDetailsStatus

type DeviceDetailsStatus struct {
}

func (*DeviceDetailsStatus) DeepCopy

func (in *DeviceDetailsStatus) DeepCopy() *DeviceDetailsStatus

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

func (*DeviceDetailsStatus) DeepCopyInto

func (in *DeviceDetailsStatus) DeepCopyInto(out *DeviceDetailsStatus)

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

type DeviceGatewayConfig

type DeviceGatewayConfig struct {
	/* Indicates whether the device is a gateway. Possible values: ["ASSOCIATION_ONLY", "DEVICE_AUTH_TOKEN_ONLY", "ASSOCIATION_AND_DEVICE_AUTH_TOKEN"]. */
	// +optional
	GatewayAuthMethod *string `json:"gatewayAuthMethod,omitempty"`

	/* Immutable. Indicates whether the device is a gateway. Default value: "NON_GATEWAY" Possible values: ["GATEWAY", "NON_GATEWAY"]. */
	// +optional
	GatewayType *string `json:"gatewayType,omitempty"`

	/* The ID of the gateway the device accessed most recently. */
	// +optional
	LastAccessedGatewayId *string `json:"lastAccessedGatewayId,omitempty"`

	/* The most recent time at which the device accessed the gateway specified in last_accessed_gateway. */
	// +optional
	LastAccessedGatewayTime *string `json:"lastAccessedGatewayTime,omitempty"`
}

func (*DeviceGatewayConfig) DeepCopy

func (in *DeviceGatewayConfig) DeepCopy() *DeviceGatewayConfig

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

func (*DeviceGatewayConfig) DeepCopyInto

func (in *DeviceGatewayConfig) DeepCopyInto(out *DeviceGatewayConfig)

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

type DeviceLastErrorStatusStatus

type DeviceLastErrorStatusStatus struct {
	/* A list of messages that carry the error details. */
	// +optional
	Details []DeviceDetailsStatus `json:"details,omitempty"`

	/* A developer-facing error message, which should be in English. */
	// +optional
	Message *string `json:"message,omitempty"`

	/* The status code, which should be an enum value of google.rpc.Code. */
	// +optional
	Number *int64 `json:"number,omitempty"`
}

func (*DeviceLastErrorStatusStatus) DeepCopy

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

func (*DeviceLastErrorStatusStatus) DeepCopyInto

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

type DevicePublicKey

type DevicePublicKey struct {
	/* The format of the key. Possible values: ["RSA_PEM", "RSA_X509_PEM", "ES256_PEM", "ES256_X509_PEM"]. */
	Format string `json:"format"`

	/* The key data. */
	Key string `json:"key"`
}

func (*DevicePublicKey) DeepCopy

func (in *DevicePublicKey) DeepCopy() *DevicePublicKey

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

func (*DevicePublicKey) DeepCopyInto

func (in *DevicePublicKey) DeepCopyInto(out *DevicePublicKey)

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

type DeviceStateStatus

type DeviceStateStatus struct {
	/* The device state data. */
	// +optional
	BinaryData *string `json:"binaryData,omitempty"`

	/* The time at which this state version was updated in Cloud IoT Core. */
	// +optional
	UpdateTime *string `json:"updateTime,omitempty"`
}

func (*DeviceStateStatus) DeepCopy

func (in *DeviceStateStatus) DeepCopy() *DeviceStateStatus

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

func (*DeviceStateStatus) DeepCopyInto

func (in *DeviceStateStatus) DeepCopyInto(out *DeviceStateStatus)

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

type DeviceregistryCredentials added in v1.109.0

type DeviceregistryCredentials struct {
	/* A public key certificate format and data. */
	PublicKeyCertificate DeviceregistryPublicKeyCertificate `json:"publicKeyCertificate"`
}

func (*DeviceregistryCredentials) DeepCopy added in v1.109.0

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

func (*DeviceregistryCredentials) DeepCopyInto added in v1.109.0

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

type DeviceregistryEventNotificationConfigs added in v1.109.0

type DeviceregistryEventNotificationConfigs struct {
	/* PubSub topic name to publish device events. */
	PubsubTopicName string `json:"pubsubTopicName"`

	/* If the subfolder name matches this string exactly, this
	configuration will be used. The string must not include the
	leading '/' character. If empty, all strings are matched. Empty
	value can only be used for the last 'event_notification_configs'
	item. */
	// +optional
	SubfolderMatches *string `json:"subfolderMatches,omitempty"`
}

func (*DeviceregistryEventNotificationConfigs) DeepCopy added in v1.109.0

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

func (*DeviceregistryEventNotificationConfigs) DeepCopyInto added in v1.109.0

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

type DeviceregistryHttpConfig added in v1.109.0

type DeviceregistryHttpConfig struct {
}

func (*DeviceregistryHttpConfig) DeepCopy added in v1.109.0

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

func (*DeviceregistryHttpConfig) DeepCopyInto added in v1.109.0

func (in *DeviceregistryHttpConfig) DeepCopyInto(out *DeviceregistryHttpConfig)

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

type DeviceregistryMqttConfig added in v1.109.0

type DeviceregistryMqttConfig struct {
}

func (*DeviceregistryMqttConfig) DeepCopy added in v1.109.0

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

func (*DeviceregistryMqttConfig) DeepCopyInto added in v1.109.0

func (in *DeviceregistryMqttConfig) DeepCopyInto(out *DeviceregistryMqttConfig)

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

type DeviceregistryPublicKeyCertificate added in v1.109.0

type DeviceregistryPublicKeyCertificate struct {
}

func (*DeviceregistryPublicKeyCertificate) DeepCopy added in v1.109.0

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

func (*DeviceregistryPublicKeyCertificate) DeepCopyInto added in v1.109.0

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

type DeviceregistryStateNotificationConfig added in v1.109.0

type DeviceregistryStateNotificationConfig struct {
}

func (*DeviceregistryStateNotificationConfig) DeepCopy added in v1.109.0

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

func (*DeviceregistryStateNotificationConfig) DeepCopyInto added in v1.109.0

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL