Skip to content

iot.v1.condition

"Condition is the Schema for the conditions API"

Index

Fields

fn new

new(name)

new returns an instance of Condition

obj metadata

"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."

fn metadata.withAnnotations

withAnnotations(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

fn metadata.withAnnotationsMixin

withAnnotationsMixin(annotations)

"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"

Note: This function appends passed data to existing values

fn metadata.withClusterName

withClusterName(clusterName)

"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."

fn metadata.withCreationTimestamp

withCreationTimestamp(creationTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withDeletionGracePeriodSeconds

withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)

"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."

fn metadata.withDeletionTimestamp

withDeletionTimestamp(deletionTimestamp)

"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."

fn metadata.withFinalizers

withFinalizers(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

fn metadata.withFinalizersMixin

withFinalizersMixin(finalizers)

"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."

Note: This function appends passed data to existing values

fn metadata.withGenerateName

withGenerateName(generateName)

"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"

fn metadata.withGeneration

withGeneration(generation)

"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."

fn metadata.withLabels

withLabels(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

fn metadata.withLabelsMixin

withLabelsMixin(labels)

"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"

Note: This function appends passed data to existing values

fn metadata.withName

withName(name)

"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"

fn metadata.withNamespace

withNamespace(namespace)

"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"

fn metadata.withOwnerReferences

withOwnerReferences(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

fn metadata.withOwnerReferencesMixin

withOwnerReferencesMixin(ownerReferences)

"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."

Note: This function appends passed data to existing values

fn metadata.withResourceVersion

withResourceVersion(resourceVersion)

"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"

withSelfLink(selfLink)

"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."

fn metadata.withUid

withUid(uid)

"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"

obj spec

"ConditionSpec defines the desired state of Condition"

fn spec.withEnabled

withEnabled(enabled)

fn spec.withMatches

withMatches(matches)

fn spec.withMatchesMixin

withMatchesMixin(matches)

Note: This function appends passed data to existing values

fn spec.withName

withName(name)

fn spec.withRemediations

withRemediations(remediations)

fn spec.withRemediationsMixin

withRemediationsMixin(remediations)

Note: This function appends passed data to existing values

fn spec.withSchedule

withSchedule(schedule)

"A cron string: * * * * *"

obj spec.matches

fn spec.matches.withLabels

withLabels(labels)

fn spec.matches.withLabelsMixin

withLabelsMixin(labels)

Note: This function appends passed data to existing values

obj spec.remediations

fn spec.remediations.withActive_brightness_delta

withActive_brightness_delta(active_brightness_delta)

"ActiveBrightnessDelta applies a relative brightness change instead of (or in addition to) an absolute ActiveState/ActiveScene. Positive walks the Brightness enum up N steps (toward BRIGHTNESS_FULL); negative walks down. Clamped at the enum boundaries. \n Bypasses the conditioner's applyDesired cache — each fire takes effect, regardless of whether the previous fire targeted the same value. This is the right semantic for \"press to brighten\": repeated presses must each bump one step. \n When set alongside ActiveState=on or unset state, the side effect of the underlying RPC also sets the zone to ON if it was OFF (\"press brighter on a dark room → turn on at the new level\")."

fn spec.remediations.withActive_compute

withActive_compute(active_compute)

"ActiveCompute is the name of a registered Computer whose result is used to drive the zone at evaluation time. On each evaluator tick (cfg.EvaluationInterval) the Conditioner invokes the named computer with (now, location, lastApplied, args) and applies the returned ApplyValues tuple via the ZoneKeeper.ApplyValues RPC. \n Computers are Go code registered at startup — there is no user- authored expression language here. Built-in computers ship with the controller; adding a new one is a code change. \n Initial set: \"sun_color_temperature\" — Brightness/ColorTemperature based on the current solar position for the configured (lat, lon). \n When set, the Remediation is evaluated every tick regardless of external triggers (it's \"always-on\"). ActiveCompute is independent of ActiveState/ActiveScene — set them too if you want the eval loop to apply a Scene first and then layer the computer's output on top (most computers will be partial: e.g. sun_color_temperature only sets ColorTemperature, leaving brightness and state untouched)."

fn spec.remediations.withActive_compute_args

withActive_compute_args(active_compute_args)

"ActiveComputeArgs are passed verbatim to the named Computer. The schema is computer-defined; consult the Computer's documentation for the supported keys."

fn spec.remediations.withActive_compute_argsMixin

withActive_compute_argsMixin(active_compute_args)

"ActiveComputeArgs are passed verbatim to the named Computer. The schema is computer-defined; consult the Computer's documentation for the supported keys."

Note: This function appends passed data to existing values

fn spec.remediations.withActive_scene

withActive_scene(active_scene)

fn spec.remediations.withActive_state

withActive_state(active_state)

fn spec.remediations.withInactive_scene

withInactive_scene(inactive_scene)

fn spec.remediations.withInactive_state

withInactive_state(inactive_state)

fn spec.remediations.withTime_intervals

withTime_intervals(time_intervals)

"TimeIntervals define the windows during which this remediation is applicable for Alerts. If the conditioner receives an event outside of this range, the zone will be set to the inactive state, if defined in the condition spec."

fn spec.remediations.withTime_intervalsMixin

withTime_intervalsMixin(time_intervals)

"TimeIntervals define the windows during which this remediation is applicable for Alerts. If the conditioner receives an event outside of this range, the zone will be set to the inactive state, if defined in the condition spec."

Note: This function appends passed data to existing values

fn spec.remediations.withZone

withZone(zone)

obj spec.remediations.time_intervals

"TimeIntervals define the windows during which this remediation is applicable for Alerts. If the conditioner receives an event outside of this range, the zone will be set to the inactive state, if defined in the condition spec."

fn spec.remediations.time_intervals.withDaysOfMonth

withDaysOfMonth(daysOfMonth)

"DaysOfMonth accepts strings like \"1\", \"-1\" (last day), \"1:5\"."

fn spec.remediations.time_intervals.withDaysOfMonthMixin

withDaysOfMonthMixin(daysOfMonth)

"DaysOfMonth accepts strings like \"1\", \"-1\" (last day), \"1:5\"."

Note: This function appends passed data to existing values

fn spec.remediations.time_intervals.withLocation

withLocation(location)

"Location is the IANA Timezone string (e.g. \"America/New_York\")."

fn spec.remediations.time_intervals.withMonths

withMonths(months)

"Months accepts strings like \"january\", \"march:may\"."

fn spec.remediations.time_intervals.withMonthsMixin

withMonthsMixin(months)

"Months accepts strings like \"january\", \"march:may\"."

Note: This function appends passed data to existing values

fn spec.remediations.time_intervals.withSun_relative

withSun_relative(sun_relative)

"SunRelative defines time windows relative to the current day's solar events at the conditioner's configured (lat, lon). Multiple SunWindow entries OR together with each other and with Times. \n A SunWindow with Event=sunset, Before=30m, After=12h opens 30m before sunset and stays open for 12.5 h — typically spanning midnight into the next morning. The window is treated as a single continuous [start, end] span (no wrap-around split), so callers observing \"is now in the window?\" semantics get the intuitive answer for evening-into-morning patterns."

fn spec.remediations.time_intervals.withSun_relativeMixin

withSun_relativeMixin(sun_relative)

"SunRelative defines time windows relative to the current day's solar events at the conditioner's configured (lat, lon). Multiple SunWindow entries OR together with each other and with Times. \n A SunWindow with Event=sunset, Before=30m, After=12h opens 30m before sunset and stays open for 12.5 h — typically spanning midnight into the next morning. The window is treated as a single continuous [start, end] span (no wrap-around split), so callers observing \"is now in the window?\" semantics get the intuitive answer for evening-into-morning patterns."

Note: This function appends passed data to existing values

fn spec.remediations.time_intervals.withTimes

withTimes(times)

"Times is a list of start/end times. We use a local struct here to ensure deepcopy generation works."

fn spec.remediations.time_intervals.withTimesMixin

withTimesMixin(times)

"Times is a list of start/end times. We use a local struct here to ensure deepcopy generation works."

Note: This function appends passed data to existing values

fn spec.remediations.time_intervals.withWeekdays

withWeekdays(weekdays)

"Weekdays accepts strings like \"monday\", \"saturday\", \"monday:wednesday\"."

fn spec.remediations.time_intervals.withWeekdaysMixin

withWeekdaysMixin(weekdays)

"Weekdays accepts strings like \"monday\", \"saturday\", \"monday:wednesday\"."

Note: This function appends passed data to existing values

fn spec.remediations.time_intervals.withYears

withYears(years)

"Years accepts strings like \"2023\", \"2023:2025\"."

fn spec.remediations.time_intervals.withYearsMixin

withYearsMixin(years)

"Years accepts strings like \"2023\", \"2023:2025\"."

Note: This function appends passed data to existing values

obj spec.remediations.time_intervals.sun_relative

"SunRelative defines time windows relative to the current day's solar events at the conditioner's configured (lat, lon). Multiple SunWindow entries OR together with each other and with Times. \n A SunWindow with Event=sunset, Before=30m, After=12h opens 30m before sunset and stays open for 12.5 h — typically spanning midnight into the next morning. The window is treated as a single continuous [start, end] span (no wrap-around split), so callers observing \"is now in the window?\" semantics get the intuitive answer for evening-into-morning patterns."

fn spec.remediations.time_intervals.sun_relative.withAfter

withAfter(after)

"After is how long after the event the window stays open. Zero (or unset) means the window closes at the event itself (i.e. an instantaneous window — generally not useful; set at least one of Before/After to a non-zero value)."

fn spec.remediations.time_intervals.sun_relative.withBefore

withBefore(before)

"Before is how long before the event the window opens. Zero (or unset) means the window opens at the event itself."

fn spec.remediations.time_intervals.sun_relative.withEvent

withEvent(event)

"Event is the anchor: \"sunrise\", \"sunset\", \"noon\", or \"midnight\". Names match the go-sunrise library convention; \"midnight\" is solar midnight, not 00:00 local time."

obj spec.remediations.time_intervals.times

"Times is a list of start/end times. We use a local struct here to ensure deepcopy generation works."

fn spec.remediations.time_intervals.times.withEnd_time

withEnd_time(end_time)

fn spec.remediations.time_intervals.times.withStart_time

withStart_time(start_time)

obj spec.remediations.when_gate

"WhenGate is relative to the Epoch event and is used to create an activation window. When the window opens, the zone is activated; when the window closes, the zone is deactivated."

fn spec.remediations.when_gate.withStart

withStart(start)

fn spec.remediations.when_gate.withStop

withStop(stop)