monitoring.v1beta1.slo
"SLO is the Schema for the SLOs API. A Service-Level Objective (SLO) describes the level of desired good service."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
fn withManagementPolicies(managementPolicies)
fn withManagementPoliciesMixin(managementPolicies)
obj spec.forProvider
fn withBasicSli(basicSli)
fn withBasicSliMixin(basicSli)
fn withCalendarPeriod(calendarPeriod)
fn withDisplayName(displayName)
fn withGoal(goal)
fn withProject(project)
fn withRequestBasedSli(requestBasedSli)
fn withRequestBasedSliMixin(requestBasedSli)
fn withRollingPeriodDays(rollingPeriodDays)
fn withService(service)
fn withSloId(sloId)
fn withUserLabels(userLabels)
fn withUserLabelsMixin(userLabels)
fn withWindowsBasedSli(windowsBasedSli)
fn withWindowsBasedSliMixin(windowsBasedSli)
obj spec.forProvider.basicSli
fn withAvailability(availability)
fn withAvailabilityMixin(availability)
fn withLatency(latency)
fn withLatencyMixin(latency)
fn withLocation(location)
fn withLocationMixin(location)
fn withMethod(method)
fn withMethodMixin(method)
fn withVersion(version)
fn withVersionMixin(version)
obj spec.forProvider.basicSli.availability
obj spec.forProvider.basicSli.latency
obj spec.forProvider.requestBasedSli
obj spec.forProvider.serviceRef
obj spec.forProvider.serviceSelector
obj spec.forProvider.windowsBasedSli
fn withGoodBadMetricFilter(goodBadMetricFilter)
fn withGoodTotalRatioThreshold(goodTotalRatioThreshold)
fn withGoodTotalRatioThresholdMixin(goodTotalRatioThreshold)
fn withMetricMeanInRange(metricMeanInRange)
fn withMetricMeanInRangeMixin(metricMeanInRange)
fn withMetricSumInRange(metricSumInRange)
fn withMetricSumInRangeMixin(metricSumInRange)
fn withWindowPeriod(windowPeriod)
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold
fn withBasicSliPerformance(basicSliPerformance)
fn withBasicSliPerformanceMixin(basicSliPerformance)
fn withPerformance(performance)
fn withPerformanceMixin(performance)
fn withThreshold(threshold)
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance
fn withAvailability(availability)
fn withAvailabilityMixin(availability)
fn withLatency(latency)
fn withLatencyMixin(latency)
fn withLocation(location)
fn withLocationMixin(location)
fn withMethod(method)
fn withMethodMixin(method)
fn withVersion(version)
fn withVersionMixin(version)
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance
fn withDistributionCut(distributionCut)
fn withDistributionCutMixin(distributionCut)
fn withGoodTotalRatio(goodTotalRatio)
fn withGoodTotalRatioMixin(goodTotalRatio)
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio
obj spec.forProvider.windowsBasedSli.metricMeanInRange
obj spec.forProvider.windowsBasedSli.metricSumInRange
obj spec.initProvider
fn withBasicSli(basicSli)
fn withBasicSliMixin(basicSli)
fn withCalendarPeriod(calendarPeriod)
fn withDisplayName(displayName)
fn withGoal(goal)
fn withProject(project)
fn withRequestBasedSli(requestBasedSli)
fn withRequestBasedSliMixin(requestBasedSli)
fn withRollingPeriodDays(rollingPeriodDays)
fn withSloId(sloId)
fn withUserLabels(userLabels)
fn withUserLabelsMixin(userLabels)
fn withWindowsBasedSli(windowsBasedSli)
fn withWindowsBasedSliMixin(windowsBasedSli)
obj spec.initProvider.basicSli
fn withAvailability(availability)
fn withAvailabilityMixin(availability)
fn withLatency(latency)
fn withLatencyMixin(latency)
fn withLocation(location)
fn withLocationMixin(location)
fn withMethod(method)
fn withMethodMixin(method)
fn withVersion(version)
fn withVersionMixin(version)
obj spec.initProvider.basicSli.availability
obj spec.initProvider.basicSli.latency
obj spec.initProvider.requestBasedSli
obj spec.initProvider.windowsBasedSli
fn withGoodBadMetricFilter(goodBadMetricFilter)
fn withGoodTotalRatioThreshold(goodTotalRatioThreshold)
fn withGoodTotalRatioThresholdMixin(goodTotalRatioThreshold)
fn withMetricMeanInRange(metricMeanInRange)
fn withMetricMeanInRangeMixin(metricMeanInRange)
fn withMetricSumInRange(metricSumInRange)
fn withMetricSumInRangeMixin(metricSumInRange)
fn withWindowPeriod(windowPeriod)
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold
fn withBasicSliPerformance(basicSliPerformance)
fn withBasicSliPerformanceMixin(basicSliPerformance)
fn withPerformance(performance)
fn withPerformanceMixin(performance)
fn withThreshold(threshold)
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance
fn withAvailability(availability)
fn withAvailabilityMixin(availability)
fn withLatency(latency)
fn withLatencyMixin(latency)
fn withLocation(location)
fn withLocationMixin(location)
fn withMethod(method)
fn withMethodMixin(method)
fn withVersion(version)
fn withVersionMixin(version)
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance
fn withDistributionCut(distributionCut)
fn withDistributionCutMixin(distributionCut)
fn withGoodTotalRatio(goodTotalRatio)
fn withGoodTotalRatioMixin(goodTotalRatio)
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio
obj spec.initProvider.windowsBasedSli.metricMeanInRange
obj spec.initProvider.windowsBasedSli.metricSumInRange
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of SLO
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"
fn metadata.withSelfLink
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
"SLOSpec defines the desired state of SLO"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withBasicSli
withBasicSli(basicSli)
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.withBasicSliMixin
withBasicSliMixin(basicSli)
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withCalendarPeriod
withCalendarPeriod(calendarPeriod)
"A calendar period, semantically \"since the start of the current \". Possible values are: DAY, WEEK, FORTNIGHT, MONTH."
fn spec.forProvider.withDisplayName
withDisplayName(displayName)
"Name used for UI elements listing this SLO."
fn spec.forProvider.withGoal
withGoal(goal)
"The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999"
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.forProvider.withRequestBasedSli
withRequestBasedSli(requestBasedSli)
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.withRequestBasedSliMixin
withRequestBasedSliMixin(requestBasedSli)
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withRollingPeriodDays
withRollingPeriodDays(rollingPeriodDays)
"A rolling time period, semantically \"in the past X days\". Must be between 1 to 30 days, inclusive."
fn spec.forProvider.withService
withService(service)
"ID of the service to which this SLO belongs."
fn spec.forProvider.withSloId
withSloId(sloId)
"The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead."
fn spec.forProvider.withUserLabels
withUserLabels(userLabels)
"This field is intended to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter."
fn spec.forProvider.withUserLabelsMixin
withUserLabelsMixin(userLabels)
"This field is intended to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter."
Note: This function appends passed data to existing values
fn spec.forProvider.withWindowsBasedSli
withWindowsBasedSli(windowsBasedSli)
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.withWindowsBasedSliMixin
withWindowsBasedSliMixin(windowsBasedSli)
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.basicSli
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.basicSli.withAvailability
withAvailability(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.forProvider.basicSli.withAvailabilityMixin
withAvailabilityMixin(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.basicSli.withLatency
withLatency(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.forProvider.basicSli.withLatencyMixin
withLatencyMixin(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.basicSli.withLocation
withLocation(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
fn spec.forProvider.basicSli.withLocationMixin
withLocationMixin(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.forProvider.basicSli.withMethod
withMethod(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
fn spec.forProvider.basicSli.withMethodMixin
withMethodMixin(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.forProvider.basicSli.withVersion
withVersion(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
fn spec.forProvider.basicSli.withVersionMixin
withVersionMixin(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
Note: This function appends passed data to existing values
obj spec.forProvider.basicSli.availability
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.forProvider.basicSli.availability.withEnabled
withEnabled(enabled)
"Whether an availability SLI is enabled or not. Must be set to true. Defaults to true."
obj spec.forProvider.basicSli.latency
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.forProvider.basicSli.latency.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.forProvider.requestBasedSli
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.requestBasedSli.withDistributionCut
withDistributionCut(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.requestBasedSli.withDistributionCutMixin
withDistributionCutMixin(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.requestBasedSli.withGoodTotalRatio
withGoodTotalRatio(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.requestBasedSli.withGoodTotalRatioMixin
withGoodTotalRatioMixin(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.requestBasedSli.distributionCut
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.requestBasedSli.distributionCut.withDistributionFilter
withDistributionFilter(distributionFilter)
"A TimeSeries monitoring filter aggregating values to quantify the good service provided. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE."
fn spec.forProvider.requestBasedSli.distributionCut.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.requestBasedSli.distributionCut.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.requestBasedSli.distributionCut.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.requestBasedSli.distributionCut.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.forProvider.requestBasedSli.distributionCut.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.forProvider.requestBasedSli.goodTotalRatio
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.requestBasedSli.goodTotalRatio.withBadServiceFilter
withBadServiceFilter(badServiceFilter)
"A TimeSeries monitoring filter quantifying bad service provided, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.forProvider.requestBasedSli.goodTotalRatio.withGoodServiceFilter
withGoodServiceFilter(goodServiceFilter)
"A TimeSeries monitoring filter quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.forProvider.requestBasedSli.goodTotalRatio.withTotalServiceFilter
withTotalServiceFilter(totalServiceFilter)
"A TimeSeries monitoring filter quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
obj spec.forProvider.serviceRef
"Reference to a CustomService in monitoring to populate service."
fn spec.forProvider.serviceRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.serviceRef.policy
"Policies for referencing."
fn spec.forProvider.serviceRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.serviceRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.serviceSelector
"Selector for a CustomService in monitoring to populate service."
fn spec.forProvider.serviceSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.serviceSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.serviceSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.serviceSelector.policy
"Policies for selection."
fn spec.forProvider.serviceSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.serviceSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.windowsBasedSli
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.forProvider.windowsBasedSli.withGoodBadMetricFilter
withGoodBadMetricFilter(goodBadMetricFilter)
"A TimeSeries monitoring filter with ValueType = BOOL. The window is good if any true values appear in the window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli."
fn spec.forProvider.windowsBasedSli.withGoodTotalRatioThreshold
withGoodTotalRatioThreshold(goodTotalRatioThreshold)
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.forProvider.windowsBasedSli.withGoodTotalRatioThresholdMixin
withGoodTotalRatioThresholdMixin(goodTotalRatioThreshold)
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.withMetricMeanInRange
withMetricMeanInRange(metricMeanInRange)
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.withMetricMeanInRangeMixin
withMetricMeanInRangeMixin(metricMeanInRange)
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.withMetricSumInRange
withMetricSumInRange(metricSumInRange)
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.forProvider.windowsBasedSli.withMetricSumInRangeMixin
withMetricSumInRangeMixin(metricSumInRange)
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.withWindowPeriod
withWindowPeriod(windowPeriod)
"Duration over which window quality is evaluated, given as a duration string \"{X}s\" representing X seconds. Must be an integer fraction of a day and at least 60s."
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.withBasicSliPerformance
withBasicSliPerformance(basicSliPerformance)
"Basic SLI to evaluate to judge window quality. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.withBasicSliPerformanceMixin
withBasicSliPerformanceMixin(basicSliPerformance)
"Basic SLI to evaluate to judge window quality. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.withPerformance
withPerformance(performance)
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.withPerformanceMixin
withPerformanceMixin(performance)
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance
"Basic SLI to evaluate to judge window quality. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withAvailability
withAvailability(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withAvailabilityMixin
withAvailabilityMixin(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLatency
withLatency(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLatencyMixin
withLatencyMixin(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLocation
withLocation(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLocationMixin
withLocationMixin(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withMethod
withMethod(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withMethodMixin
withMethodMixin(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withVersion
withVersion(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withVersionMixin
withVersionMixin(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
Note: This function appends passed data to existing values
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability.withEnabled
withEnabled(enabled)
"Whether an availability SLI is enabled or not. Must be set to true. Defaults to true."
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withDistributionCut
withDistributionCut(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withDistributionCutMixin
withDistributionCutMixin(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withGoodTotalRatio
withGoodTotalRatio(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withGoodTotalRatioMixin
withGoodTotalRatioMixin(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withDistributionFilter
withDistributionFilter(distributionFilter)
"A TimeSeries monitoring filter aggregating values to quantify the good service provided. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withBadServiceFilter
withBadServiceFilter(badServiceFilter)
"A TimeSeries monitoring filter quantifying bad service provided, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withGoodServiceFilter
withGoodServiceFilter(goodServiceFilter)
"A TimeSeries monitoring filter quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.forProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withTotalServiceFilter
withTotalServiceFilter(totalServiceFilter)
"A TimeSeries monitoring filter quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
obj spec.forProvider.windowsBasedSli.metricMeanInRange
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricMeanInRange.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricMeanInRange.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.metricMeanInRange.withTimeSeries
withTimeSeries(timeSeries)
"A monitoring filter specifying the TimeSeries to use for evaluating window quality. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE. Summed value X should satisfy range.min <= X <= range.max for a good window."
obj spec.forProvider.windowsBasedSli.metricMeanInRange.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricMeanInRange.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.forProvider.windowsBasedSli.metricMeanInRange.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.forProvider.windowsBasedSli.metricSumInRange
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricSumInRange.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricSumInRange.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.windowsBasedSli.metricSumInRange.withTimeSeries
withTimeSeries(timeSeries)
"A monitoring filter specifying the TimeSeries to use for evaluating window quality. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE. Summed value X should satisfy range.min <= X <= range.max for a good window."
obj spec.forProvider.windowsBasedSli.metricSumInRange.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.forProvider.windowsBasedSli.metricSumInRange.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.forProvider.windowsBasedSli.metricSumInRange.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler."
fn spec.initProvider.withBasicSli
withBasicSli(basicSli)
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.withBasicSliMixin
withBasicSliMixin(basicSli)
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withCalendarPeriod
withCalendarPeriod(calendarPeriod)
"A calendar period, semantically \"since the start of the current \". Possible values are: DAY, WEEK, FORTNIGHT, MONTH."
fn spec.initProvider.withDisplayName
withDisplayName(displayName)
"Name used for UI elements listing this SLO."
fn spec.initProvider.withGoal
withGoal(goal)
"The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999"
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which the resource belongs. If it is not provided, the provider project is used."
fn spec.initProvider.withRequestBasedSli
withRequestBasedSli(requestBasedSli)
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.withRequestBasedSliMixin
withRequestBasedSliMixin(requestBasedSli)
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withRollingPeriodDays
withRollingPeriodDays(rollingPeriodDays)
"A rolling time period, semantically \"in the past X days\". Must be between 1 to 30 days, inclusive."
fn spec.initProvider.withSloId
withSloId(sloId)
"The id to use for this ServiceLevelObjective. If omitted, an id will be generated instead."
fn spec.initProvider.withUserLabels
withUserLabels(userLabels)
"This field is intended to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter."
fn spec.initProvider.withUserLabelsMixin
withUserLabelsMixin(userLabels)
"This field is intended to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter."
Note: This function appends passed data to existing values
fn spec.initProvider.withWindowsBasedSli
withWindowsBasedSli(windowsBasedSli)
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.withWindowsBasedSliMixin
withWindowsBasedSliMixin(windowsBasedSli)
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.basicSli
"Basic Service-Level Indicator (SLI) on a well-known service type. Performance will be computed on the basis of pre-defined metrics. SLIs are used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.basicSli.withAvailability
withAvailability(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.initProvider.basicSli.withAvailabilityMixin
withAvailabilityMixin(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.basicSli.withLatency
withLatency(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.initProvider.basicSli.withLatencyMixin
withLatencyMixin(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.basicSli.withLocation
withLocation(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
fn spec.initProvider.basicSli.withLocationMixin
withLocationMixin(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.initProvider.basicSli.withMethod
withMethod(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
fn spec.initProvider.basicSli.withMethodMixin
withMethodMixin(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.initProvider.basicSli.withVersion
withVersion(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
fn spec.initProvider.basicSli.withVersionMixin
withVersionMixin(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
Note: This function appends passed data to existing values
obj spec.initProvider.basicSli.availability
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.initProvider.basicSli.availability.withEnabled
withEnabled(enabled)
"Whether an availability SLI is enabled or not. Must be set to true. Defaults to true."
obj spec.initProvider.basicSli.latency
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.initProvider.basicSli.latency.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.initProvider.requestBasedSli
"A request-based SLI defines a SLI for which atomic units of service are counted directly. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.requestBasedSli.withDistributionCut
withDistributionCut(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.requestBasedSli.withDistributionCutMixin
withDistributionCutMixin(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.requestBasedSli.withGoodTotalRatio
withGoodTotalRatio(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.requestBasedSli.withGoodTotalRatioMixin
withGoodTotalRatioMixin(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.requestBasedSli.distributionCut
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.requestBasedSli.distributionCut.withDistributionFilter
withDistributionFilter(distributionFilter)
"A TimeSeries monitoring filter aggregating values to quantify the good service provided. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE."
fn spec.initProvider.requestBasedSli.distributionCut.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.requestBasedSli.distributionCut.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.requestBasedSli.distributionCut.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.requestBasedSli.distributionCut.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.initProvider.requestBasedSli.distributionCut.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.initProvider.requestBasedSli.goodTotalRatio
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.requestBasedSli.goodTotalRatio.withBadServiceFilter
withBadServiceFilter(badServiceFilter)
"A TimeSeries monitoring filter quantifying bad service provided, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.initProvider.requestBasedSli.goodTotalRatio.withGoodServiceFilter
withGoodServiceFilter(goodServiceFilter)
"A TimeSeries monitoring filter quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.initProvider.requestBasedSli.goodTotalRatio.withTotalServiceFilter
withTotalServiceFilter(totalServiceFilter)
"A TimeSeries monitoring filter quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
obj spec.initProvider.windowsBasedSli
"A windows-based SLI defines the criteria for time windows. good_service is defined based off the count of these time windows for which the provided service was of good quality. A SLI describes a good service. It is used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. Exactly one of the following must be set: basic_sli, request_based_sli, windows_based_sli Structure is documented below."
fn spec.initProvider.windowsBasedSli.withGoodBadMetricFilter
withGoodBadMetricFilter(goodBadMetricFilter)
"A TimeSeries monitoring filter with ValueType = BOOL. The window is good if any true values appear in the window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli."
fn spec.initProvider.windowsBasedSli.withGoodTotalRatioThreshold
withGoodTotalRatioThreshold(goodTotalRatioThreshold)
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.initProvider.windowsBasedSli.withGoodTotalRatioThresholdMixin
withGoodTotalRatioThresholdMixin(goodTotalRatioThreshold)
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.withMetricMeanInRange
withMetricMeanInRange(metricMeanInRange)
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.withMetricMeanInRangeMixin
withMetricMeanInRangeMixin(metricMeanInRange)
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.withMetricSumInRange
withMetricSumInRange(metricSumInRange)
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.initProvider.windowsBasedSli.withMetricSumInRangeMixin
withMetricSumInRangeMixin(metricSumInRange)
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.withWindowPeriod
withWindowPeriod(windowPeriod)
"Duration over which window quality is evaluated, given as a duration string \"{X}s\" representing X seconds. Must be an integer fraction of a day and at least 60s."
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold
"Criterion that describes a window as good if its performance is high enough. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.withBasicSliPerformance
withBasicSliPerformance(basicSliPerformance)
"Basic SLI to evaluate to judge window quality. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.withBasicSliPerformanceMixin
withBasicSliPerformanceMixin(basicSliPerformance)
"Basic SLI to evaluate to judge window quality. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.withPerformance
withPerformance(performance)
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.withPerformanceMixin
withPerformanceMixin(performance)
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance
"Basic SLI to evaluate to judge window quality. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withAvailability
withAvailability(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withAvailabilityMixin
withAvailabilityMixin(availability)
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLatency
withLatency(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLatencyMixin
withLatencyMixin(latency)
"Parameters for a latency threshold SLI. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLocation
withLocation(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withLocationMixin
withLocationMixin(location)
"An optional set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withMethod
withMethod(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withMethodMixin
withMethodMixin(method)
"An optional set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the Service's methods. For service types that don't support breaking down by method, setting this field will result in an error."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withVersion
withVersion(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.withVersionMixin
withVersionMixin(version)
"The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error."
Note: This function appends passed data to existing values
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability
"Availability based SLI, dervied from count of requests made to this service that return successfully. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.availability.withEnabled
withEnabled(enabled)
"Whether an availability SLI is enabled or not. Must be set to true. Defaults to true."
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency
"Parameters for a latency threshold SLI. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.basicSliPerformance.latency.withThreshold
withThreshold(threshold)
"A duration string, e.g. 10s. Good service is defined to be the count of requests made to this service that return in no more than threshold."
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance
"Request-based SLI to evaluate to judge window quality. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withDistributionCut
withDistributionCut(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withDistributionCutMixin
withDistributionCutMixin(distributionCut)
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withGoodTotalRatio
withGoodTotalRatio(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.withGoodTotalRatioMixin
withGoodTotalRatioMixin(goodTotalRatio)
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut
"Used when good_service is defined by a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values aggregated in the Distribution. Defines a distribution TimeSeries filter and thresholds used for measuring good service and total service. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withDistributionFilter
withDistributionFilter(distributionFilter)
"A TimeSeries monitoring filter aggregating values to quantify the good service provided. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or MetricKind = CUMULATIVE."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.distributionCut.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio
"A means to compute a ratio of good_service to total_service. Defines computing this ratio with two TimeSeries monitoring filters Must specify exactly two of good, bad, and total service filters. The relationship good_service + bad_service = total_service will be assumed. Exactly one of distribution_cut or good_total_ratio can be set. Structure is documented below."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withBadServiceFilter
withBadServiceFilter(badServiceFilter)
"A TimeSeries monitoring filter quantifying bad service provided, either demanded service that was not provided or demanded service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withGoodServiceFilter
withGoodServiceFilter(goodServiceFilter)
"A TimeSeries monitoring filter quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
fn spec.initProvider.windowsBasedSli.goodTotalRatioThreshold.performance.goodTotalRatio.withTotalServiceFilter
withTotalServiceFilter(totalServiceFilter)
"A TimeSeries monitoring filter quantifying total demanded service. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE. Exactly two of good_service_filter,bad_service_filter,total_service_filter must be set (good + bad = total is assumed)."
obj spec.initProvider.windowsBasedSli.metricMeanInRange
"Criterion that describes a window as good if the metric's value is in a good range, averaged across returned streams. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Average value X of time_series should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricMeanInRange.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricMeanInRange.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.metricMeanInRange.withTimeSeries
withTimeSeries(timeSeries)
"A monitoring filter specifying the TimeSeries to use for evaluating window quality. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE. Summed value X should satisfy range.min <= X <= range.max for a good window."
obj spec.initProvider.windowsBasedSli.metricMeanInRange.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricMeanInRange.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.initProvider.windowsBasedSli.metricMeanInRange.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.initProvider.windowsBasedSli.metricSumInRange
"Criterion that describes a window as good if the metric's value is in a good range, summed across returned streams. Summed value X of time_series should satisfy range.min <= X <= range.max for a good window. One of good_bad_metric_filter, good_total_ratio_threshold, metric_mean_in_range, metric_sum_in_range must be set for windows_based_sli. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricSumInRange.withRange
withRange(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricSumInRange.withRangeMixin
withRangeMixin(range)
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.windowsBasedSli.metricSumInRange.withTimeSeries
withTimeSeries(timeSeries)
"A monitoring filter specifying the TimeSeries to use for evaluating window quality. The provided TimeSeries must have ValueType = INT64 or ValueType = DOUBLE and MetricKind = GAUGE. Summed value X should satisfy range.min <= X <= range.max for a good window."
obj spec.initProvider.windowsBasedSli.metricSumInRange.range
"Range of numerical values. The computed good_service will be the count of values x in the Distribution such that range.min <= x <= range.max. inclusive of min and max. Open ranges can be defined by setting just one of min or max. Summed value X should satisfy range.min <= X <= range.max for a good window. Structure is documented below."
fn spec.initProvider.windowsBasedSli.metricSumInRange.range.withMax
withMax(max)
"max value for the range (inclusive). If not given, will be set to 0"
fn spec.initProvider.windowsBasedSli.metricSumInRange.range.withMin
withMin(min)
"Min value for the range (inclusive). If not given, will be set to 0"
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."