Skip to content

datadoghq.v1alpha1.datadogDashboard

"DatadogDashboard is the Schema for the datadogdashboards API"

Index

Fields

fn new

new(name)

new returns an instance of DatadogDashboard

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

"DatadogDashboardSpec defines the desired state of DatadogDashboard"

fn spec.withDescription

withDescription(description)

"Description is the description of the dashboard."

fn spec.withLayoutType

withLayoutType(layoutType)

"LayoutType is the layout type of the dashboard."

fn spec.withNotifyList

withNotifyList(notifyList)

"NotifyList is the list of handles of users to notify when changes are made to this dashboard."

fn spec.withNotifyListMixin

withNotifyListMixin(notifyList)

"NotifyList is the list of handles of users to notify when changes are made to this dashboard."

Note: This function appends passed data to existing values

fn spec.withReflowType

withReflowType(reflowType)

"Reflowtype is the reflow type for a 'new dashboard layout' dashboard. Set this only when layout type is 'ordered'.\nIf set to 'fixed', the dashboard expects all widgets to have a layout, and if it's set to 'auto',\nwidgets should not have layouts."

fn spec.withTags

withTags(tags)

"Tags is a list of team names representing ownership of a dashboard."

fn spec.withTagsMixin

withTagsMixin(tags)

"Tags is a list of team names representing ownership of a dashboard."

Note: This function appends passed data to existing values

fn spec.withTemplateVariablePresets

withTemplateVariablePresets(templateVariablePresets)

"TemplateVariablePresets is an array of template variables saved views."

fn spec.withTemplateVariablePresetsMixin

withTemplateVariablePresetsMixin(templateVariablePresets)

"TemplateVariablePresets is an array of template variables saved views."

Note: This function appends passed data to existing values

fn spec.withTemplateVariables

withTemplateVariables(templateVariables)

"TemplateVariables is a list of template variables for this dashboard."

fn spec.withTemplateVariablesMixin

withTemplateVariablesMixin(templateVariables)

"TemplateVariables is a list of template variables for this dashboard."

Note: This function appends passed data to existing values

fn spec.withTitle

withTitle(title)

"Title is the title of the dashboard."

fn spec.withWidgets

withWidgets(widgets)

"Widgets is a JSON string representation of a list of Datadog API Widgets"

obj spec.templateVariablePresets

"TemplateVariablePresets is an array of template variables saved views."

fn spec.templateVariablePresets.withName

withName(name)

"The name of the variable."

fn spec.templateVariablePresets.withTemplateVariables

withTemplateVariables(templateVariables)

"List of variables."

fn spec.templateVariablePresets.withTemplateVariablesMixin

withTemplateVariablesMixin(templateVariables)

"List of variables."

Note: This function appends passed data to existing values

obj spec.templateVariablePresets.templateVariables

"List of variables."

fn spec.templateVariablePresets.templateVariables.withName

withName(name)

"The name of the variable."

fn spec.templateVariablePresets.templateVariables.withValues

withValues(values)

"One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value."

fn spec.templateVariablePresets.templateVariables.withValuesMixin

withValuesMixin(values)

"One or many template variable values within the saved view, which will be unioned together using OR if more than one is specified. Cannot be used in conjunction with value."

Note: This function appends passed data to existing values

obj spec.templateVariables

"TemplateVariables is a list of template variables for this dashboard."

fn spec.templateVariables.withAvailableValues

withAvailableValues(availableValues)

"The list of values that the template variable drop-down is limited to."

fn spec.templateVariables.withAvailableValuesMixin

withAvailableValuesMixin(availableValues)

"The list of values that the template variable drop-down is limited to."

Note: This function appends passed data to existing values

fn spec.templateVariables.withDefaults

withDefaults(defaults)

"One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default."

fn spec.templateVariables.withDefaultsMixin

withDefaultsMixin(defaults)

"One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default."

Note: This function appends passed data to existing values

fn spec.templateVariables.withName

withName(name)

"The name of the variable."

fn spec.templateVariables.withPrefix

withPrefix(prefix)

"The tag prefix associated with the variable. Only tags with this prefix appear in the variable drop-down."