monitoring.v1beta1.monitoringDashboard

Index

fn new(name)
obj metadata
obj spec

Fields

fn new

new(name)

new returns an instance of MonitoringDashboard

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

fn spec.withDisplayName

withDisplayName(displayName)

"Required. The mutable, human-readable name."

fn spec.withResourceID

withResourceID(resourceID)

"Immutable. Optional. The name of the resource. Used for creation and acquisition. When unset, the value of metadata.name is used as the default."

obj spec.columnLayout

"The content is divided into equally spaced columns and the widgets are arranged vertically."

fn spec.columnLayout.withColumns

withColumns(columns)

"The columns of content to display."

fn spec.columnLayout.withColumnsMixin

withColumnsMixin(columns)

"The columns of content to display."

Note: This function appends passed data to existing values

obj spec.columnLayout.columns

"The columns of content to display."

fn spec.columnLayout.columns.withWeight

withWeight(weight)

"The relative weight of this column. The column weight is used to adjust the width of columns on the screen (relative to peers). Greater the weight, greater the width of the column on the screen. If omitted, a value of 1 is used while rendering."

fn spec.columnLayout.columns.withWidgets

withWidgets(widgets)

"The display widgets arranged vertically in this column."

fn spec.columnLayout.columns.withWidgetsMixin

withWidgetsMixin(widgets)

"The display widgets arranged vertically in this column."

Note: This function appends passed data to existing values

obj spec.columnLayout.columns.widgets

"The display widgets arranged vertically in this column."

fn spec.columnLayout.columns.widgets.withBlank

withBlank(blank)

"A blank space."

fn spec.columnLayout.columns.widgets.withBlankMixin

withBlankMixin(blank)

"A blank space."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.withTitle

withTitle(title)

"Optional. The title of the widget."

obj spec.columnLayout.columns.widgets.scorecard

"A scorecard summarizing time series data."

fn spec.columnLayout.columns.widgets.scorecard.withThresholds

withThresholds(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.columnLayout.columns.widgets.scorecard.withThresholdsMixin

withThresholdsMixin(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

Note: This function appends passed data to existing values

obj spec.columnLayout.columns.widgets.scorecard.gaugeView

"Will cause the scorecard to show a gauge chart."

fn spec.columnLayout.columns.widgets.scorecard.gaugeView.withLowerBound

withLowerBound(lowerBound)

"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."

fn spec.columnLayout.columns.widgets.scorecard.gaugeView.withUpperBound

withUpperBound(upperBound)

"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."

obj spec.columnLayout.columns.widgets.scorecard.sparkChartView

"Will cause the scorecard to show a spark chart."

fn spec.columnLayout.columns.widgets.scorecard.sparkChartView.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint."

fn spec.columnLayout.columns.widgets.scorecard.sparkChartView.withSparkChartType

withSparkChartType(sparkChartType)

"Required. The type of sparkchart to show in this chartView. Possible values: SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE, SPARK_BAR"

obj spec.columnLayout.columns.widgets.scorecard.thresholds

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.columnLayout.columns.widgets.scorecard.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.columnLayout.columns.widgets.scorecard.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.columnLayout.columns.widgets.scorecard.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.columnLayout.columns.widgets.scorecard.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.text

"A raw string or markdown displaying textual content."

fn spec.columnLayout.columns.widgets.text.withContent

withContent(content)

"The text content to be displayed."

fn spec.columnLayout.columns.widgets.text.withFormat

withFormat(format)

"How the text content is formatted. Possible values: FORMAT_UNSPECIFIED, MARKDOWN, RAW"

obj spec.columnLayout.columns.widgets.xyChart

"A chart of time series data."

fn spec.columnLayout.columns.widgets.xyChart.withDataSets

withDataSets(dataSets)

"Required. The data displayed in this chart."

fn spec.columnLayout.columns.widgets.xyChart.withDataSetsMixin

withDataSetsMixin(dataSets)

"Required. The data displayed in this chart."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.withThresholds

withThresholds(thresholds)

"Threshold lines drawn horizontally across the chart."

fn spec.columnLayout.columns.widgets.xyChart.withThresholdsMixin

withThresholdsMixin(thresholds)

"Threshold lines drawn horizontally across the chart."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.withTimeshiftDuration

withTimeshiftDuration(timeshiftDuration)

"The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type."

obj spec.columnLayout.columns.widgets.xyChart.chartOptions

"Display options for the chart."

fn spec.columnLayout.columns.widgets.xyChart.chartOptions.withMode

withMode(mode)

"The chart mode. Possible values: MODE_UNSPECIFIED, COLOR, X_RAY, STATS"

obj spec.columnLayout.columns.widgets.xyChart.dataSets

"Required. The data displayed in this chart."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.withLegendTemplate

withLegendTemplate(legendTemplate)

"A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value. "

fn spec.columnLayout.columns.widgets.xyChart.dataSets.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.withPlotType

withPlotType(plotType)

"How this data should be plotted on the chart. Possible values: PLOT_TYPE_UNSPECIFIED, LINE, STACKED_AREA, STACKED_BAR, HEATMAP"

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.columnLayout.columns.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.columnLayout.columns.widgets.xyChart.thresholds

"Threshold lines drawn horizontally across the chart."

fn spec.columnLayout.columns.widgets.xyChart.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.columnLayout.columns.widgets.xyChart.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.columnLayout.columns.widgets.xyChart.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.columnLayout.columns.widgets.xyChart.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.columnLayout.columns.widgets.xyChart.xAxis

"The properties applied to the X axis."

fn spec.columnLayout.columns.widgets.xyChart.xAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.columnLayout.columns.widgets.xyChart.xAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.columnLayout.columns.widgets.xyChart.yAxis

"The properties applied to the Y axis."

fn spec.columnLayout.columns.widgets.xyChart.yAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.columnLayout.columns.widgets.xyChart.yAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.gridLayout

"Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles."

fn spec.gridLayout.withColumns

withColumns(columns)

"The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering."

fn spec.gridLayout.withWidgets

withWidgets(widgets)

"The informational elements that are arranged into the columns row-first."

fn spec.gridLayout.withWidgetsMixin

withWidgetsMixin(widgets)

"The informational elements that are arranged into the columns row-first."

Note: This function appends passed data to existing values

obj spec.gridLayout.widgets

"The informational elements that are arranged into the columns row-first."

fn spec.gridLayout.widgets.withBlank

withBlank(blank)

"A blank space."

fn spec.gridLayout.widgets.withBlankMixin

withBlankMixin(blank)

"A blank space."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.withTitle

withTitle(title)

"Optional. The title of the widget."

obj spec.gridLayout.widgets.scorecard

"A scorecard summarizing time series data."

fn spec.gridLayout.widgets.scorecard.withThresholds

withThresholds(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.gridLayout.widgets.scorecard.withThresholdsMixin

withThresholdsMixin(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

Note: This function appends passed data to existing values

obj spec.gridLayout.widgets.scorecard.gaugeView

"Will cause the scorecard to show a gauge chart."

fn spec.gridLayout.widgets.scorecard.gaugeView.withLowerBound

withLowerBound(lowerBound)

"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."

fn spec.gridLayout.widgets.scorecard.gaugeView.withUpperBound

withUpperBound(upperBound)

"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."

obj spec.gridLayout.widgets.scorecard.sparkChartView

"Will cause the scorecard to show a spark chart."

fn spec.gridLayout.widgets.scorecard.sparkChartView.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint."

fn spec.gridLayout.widgets.scorecard.sparkChartView.withSparkChartType

withSparkChartType(sparkChartType)

"Required. The type of sparkchart to show in this chartView. Possible values: SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE, SPARK_BAR"

obj spec.gridLayout.widgets.scorecard.thresholds

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.gridLayout.widgets.scorecard.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.gridLayout.widgets.scorecard.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.gridLayout.widgets.scorecard.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.gridLayout.widgets.scorecard.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.text

"A raw string or markdown displaying textual content."

fn spec.gridLayout.widgets.text.withContent

withContent(content)

"The text content to be displayed."

fn spec.gridLayout.widgets.text.withFormat

withFormat(format)

"How the text content is formatted. Possible values: FORMAT_UNSPECIFIED, MARKDOWN, RAW"

obj spec.gridLayout.widgets.xyChart

"A chart of time series data."

fn spec.gridLayout.widgets.xyChart.withDataSets

withDataSets(dataSets)

"Required. The data displayed in this chart."

fn spec.gridLayout.widgets.xyChart.withDataSetsMixin

withDataSetsMixin(dataSets)

"Required. The data displayed in this chart."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.withThresholds

withThresholds(thresholds)

"Threshold lines drawn horizontally across the chart."

fn spec.gridLayout.widgets.xyChart.withThresholdsMixin

withThresholdsMixin(thresholds)

"Threshold lines drawn horizontally across the chart."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.withTimeshiftDuration

withTimeshiftDuration(timeshiftDuration)

"The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type."

obj spec.gridLayout.widgets.xyChart.chartOptions

"Display options for the chart."

fn spec.gridLayout.widgets.xyChart.chartOptions.withMode

withMode(mode)

"The chart mode. Possible values: MODE_UNSPECIFIED, COLOR, X_RAY, STATS"

obj spec.gridLayout.widgets.xyChart.dataSets

"Required. The data displayed in this chart."

fn spec.gridLayout.widgets.xyChart.dataSets.withLegendTemplate

withLegendTemplate(legendTemplate)

"A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value. "

fn spec.gridLayout.widgets.xyChart.dataSets.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals."

fn spec.gridLayout.widgets.xyChart.dataSets.withPlotType

withPlotType(plotType)

"How this data should be plotted on the chart. Possible values: PLOT_TYPE_UNSPECIFIED, LINE, STACKED_AREA, STACKED_BAR, HEATMAP"

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.gridLayout.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.gridLayout.widgets.xyChart.thresholds

"Threshold lines drawn horizontally across the chart."

fn spec.gridLayout.widgets.xyChart.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.gridLayout.widgets.xyChart.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.gridLayout.widgets.xyChart.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.gridLayout.widgets.xyChart.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.gridLayout.widgets.xyChart.xAxis

"The properties applied to the X axis."

fn spec.gridLayout.widgets.xyChart.xAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.gridLayout.widgets.xyChart.xAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.gridLayout.widgets.xyChart.yAxis

"The properties applied to the Y axis."

fn spec.gridLayout.widgets.xyChart.yAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.gridLayout.widgets.xyChart.yAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.mosaicLayout

"The content is arranged as a grid of tiles, with each content widget occupying one or more tiles."

fn spec.mosaicLayout.withColumns

withColumns(columns)

"The number of columns in the mosaic grid."

fn spec.mosaicLayout.withTiles

withTiles(tiles)

"The tiles to display."

fn spec.mosaicLayout.withTilesMixin

withTilesMixin(tiles)

"The tiles to display."

Note: This function appends passed data to existing values

obj spec.mosaicLayout.tiles

"The tiles to display."

fn spec.mosaicLayout.tiles.withHeight

withHeight(height)

"The height of the tile, measured in grid squares."

fn spec.mosaicLayout.tiles.withWidth

withWidth(width)

"The width of the tile, measured in grid squares."

fn spec.mosaicLayout.tiles.withXPos

withXPos(xPos)

"The zero-indexed position of the tile in grid squares relative to the left edge of the grid."

fn spec.mosaicLayout.tiles.withYPos

withYPos(yPos)

"The zero-indexed position of the tile in grid squares relative to the top edge of the grid."

obj spec.mosaicLayout.tiles.widget

"The informational widget contained in the tile."

fn spec.mosaicLayout.tiles.widget.withBlank

withBlank(blank)

"A blank space."

fn spec.mosaicLayout.tiles.widget.withBlankMixin

withBlankMixin(blank)

"A blank space."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.withTitle

withTitle(title)

"Optional. The title of the widget."

obj spec.mosaicLayout.tiles.widget.scorecard

"A scorecard summarizing time series data."

fn spec.mosaicLayout.tiles.widget.scorecard.withThresholds

withThresholds(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.mosaicLayout.tiles.widget.scorecard.withThresholdsMixin

withThresholdsMixin(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

Note: This function appends passed data to existing values

obj spec.mosaicLayout.tiles.widget.scorecard.gaugeView

"Will cause the scorecard to show a gauge chart."

fn spec.mosaicLayout.tiles.widget.scorecard.gaugeView.withLowerBound

withLowerBound(lowerBound)

"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."

fn spec.mosaicLayout.tiles.widget.scorecard.gaugeView.withUpperBound

withUpperBound(upperBound)

"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."

obj spec.mosaicLayout.tiles.widget.scorecard.sparkChartView

"Will cause the scorecard to show a spark chart."

fn spec.mosaicLayout.tiles.widget.scorecard.sparkChartView.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint."

fn spec.mosaicLayout.tiles.widget.scorecard.sparkChartView.withSparkChartType

withSparkChartType(sparkChartType)

"Required. The type of sparkchart to show in this chartView. Possible values: SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE, SPARK_BAR"

obj spec.mosaicLayout.tiles.widget.scorecard.thresholds

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.mosaicLayout.tiles.widget.scorecard.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.text

"A raw string or markdown displaying textual content."

fn spec.mosaicLayout.tiles.widget.text.withContent

withContent(content)

"The text content to be displayed."

fn spec.mosaicLayout.tiles.widget.text.withFormat

withFormat(format)

"How the text content is formatted. Possible values: FORMAT_UNSPECIFIED, MARKDOWN, RAW"

obj spec.mosaicLayout.tiles.widget.xyChart

"A chart of time series data."

fn spec.mosaicLayout.tiles.widget.xyChart.withDataSets

withDataSets(dataSets)

"Required. The data displayed in this chart."

fn spec.mosaicLayout.tiles.widget.xyChart.withDataSetsMixin

withDataSetsMixin(dataSets)

"Required. The data displayed in this chart."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.withThresholds

withThresholds(thresholds)

"Threshold lines drawn horizontally across the chart."

fn spec.mosaicLayout.tiles.widget.xyChart.withThresholdsMixin

withThresholdsMixin(thresholds)

"Threshold lines drawn horizontally across the chart."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.withTimeshiftDuration

withTimeshiftDuration(timeshiftDuration)

"The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type."

obj spec.mosaicLayout.tiles.widget.xyChart.chartOptions

"Display options for the chart."

fn spec.mosaicLayout.tiles.widget.xyChart.chartOptions.withMode

withMode(mode)

"The chart mode. Possible values: MODE_UNSPECIFIED, COLOR, X_RAY, STATS"

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets

"Required. The data displayed in this chart."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withLegendTemplate

withLegendTemplate(legendTemplate)

"A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value. "

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.withPlotType

withPlotType(plotType)

"How this data should be plotted on the chart. Possible values: PLOT_TYPE_UNSPECIFIED, LINE, STACKED_AREA, STACKED_BAR, HEATMAP"

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.mosaicLayout.tiles.widget.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.mosaicLayout.tiles.widget.xyChart.thresholds

"Threshold lines drawn horizontally across the chart."

fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.mosaicLayout.tiles.widget.xyChart.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.mosaicLayout.tiles.widget.xyChart.xAxis

"The properties applied to the X axis."

fn spec.mosaicLayout.tiles.widget.xyChart.xAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.mosaicLayout.tiles.widget.xyChart.xAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.mosaicLayout.tiles.widget.xyChart.yAxis

"The properties applied to the Y axis."

fn spec.mosaicLayout.tiles.widget.xyChart.yAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.mosaicLayout.tiles.widget.xyChart.yAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.projectRef

"The Project that this resource belongs to."

fn spec.projectRef.withExternal

withExternal(external)

"The project id of the resource.\n\nAllowed value: The Google Cloud resource name of a Project resource (format: projects/{{name}})."

fn spec.projectRef.withName

withName(name)

"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names"

fn spec.projectRef.withNamespace

withNamespace(namespace)

"Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"

obj spec.rowLayout

"The content is divided into equally spaced rows and the widgets are arranged horizontally."

fn spec.rowLayout.withRows

withRows(rows)

"The rows of content to display."

fn spec.rowLayout.withRowsMixin

withRowsMixin(rows)

"The rows of content to display."

Note: This function appends passed data to existing values

obj spec.rowLayout.rows

"The rows of content to display."

fn spec.rowLayout.rows.withWeight

withWeight(weight)

"The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers). Greater the weight, greater the height of the row on the screen. If omitted, a value of 1 is used while rendering."

fn spec.rowLayout.rows.withWidgets

withWidgets(widgets)

"The display widgets arranged horizontally in this row."

fn spec.rowLayout.rows.withWidgetsMixin

withWidgetsMixin(widgets)

"The display widgets arranged horizontally in this row."

Note: This function appends passed data to existing values

obj spec.rowLayout.rows.widgets

"The display widgets arranged horizontally in this row."

fn spec.rowLayout.rows.widgets.withBlank

withBlank(blank)

"A blank space."

fn spec.rowLayout.rows.widgets.withBlankMixin

withBlankMixin(blank)

"A blank space."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.withTitle

withTitle(title)

"Optional. The title of the widget."

obj spec.rowLayout.rows.widgets.scorecard

"A scorecard summarizing time series data."

fn spec.rowLayout.rows.widgets.scorecard.withThresholds

withThresholds(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.rowLayout.rows.widgets.scorecard.withThresholdsMixin

withThresholdsMixin(thresholds)

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

Note: This function appends passed data to existing values

obj spec.rowLayout.rows.widgets.scorecard.gaugeView

"Will cause the scorecard to show a gauge chart."

fn spec.rowLayout.rows.widgets.scorecard.gaugeView.withLowerBound

withLowerBound(lowerBound)

"The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this."

fn spec.rowLayout.rows.widgets.scorecard.gaugeView.withUpperBound

withUpperBound(upperBound)

"The upper bound for this gauge chart. The value of the chart should always be less than or equal to this."

obj spec.rowLayout.rows.widgets.scorecard.sparkChartView

"Will cause the scorecard to show a spark chart."

fn spec.rowLayout.rows.widgets.scorecard.sparkChartView.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint."

fn spec.rowLayout.rows.widgets.scorecard.sparkChartView.withSparkChartType

withSparkChartType(sparkChartType)

"Required. The type of sparkchart to show in this chartView. Possible values: SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE, SPARK_BAR"

obj spec.rowLayout.rows.widgets.scorecard.thresholds

"The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.) As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', },: { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state."

fn spec.rowLayout.rows.widgets.scorecard.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.rowLayout.rows.widgets.scorecard.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.rowLayout.rows.widgets.scorecard.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.rowLayout.rows.widgets.scorecard.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.scorecard.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.text

"A raw string or markdown displaying textual content."

fn spec.rowLayout.rows.widgets.text.withContent

withContent(content)

"The text content to be displayed."

fn spec.rowLayout.rows.widgets.text.withFormat

withFormat(format)

"How the text content is formatted. Possible values: FORMAT_UNSPECIFIED, MARKDOWN, RAW"

obj spec.rowLayout.rows.widgets.xyChart

"A chart of time series data."

fn spec.rowLayout.rows.widgets.xyChart.withDataSets

withDataSets(dataSets)

"Required. The data displayed in this chart."

fn spec.rowLayout.rows.widgets.xyChart.withDataSetsMixin

withDataSetsMixin(dataSets)

"Required. The data displayed in this chart."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.withThresholds

withThresholds(thresholds)

"Threshold lines drawn horizontally across the chart."

fn spec.rowLayout.rows.widgets.xyChart.withThresholdsMixin

withThresholdsMixin(thresholds)

"Threshold lines drawn horizontally across the chart."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.withTimeshiftDuration

withTimeshiftDuration(timeshiftDuration)

"The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type."

obj spec.rowLayout.rows.widgets.xyChart.chartOptions

"Display options for the chart."

fn spec.rowLayout.rows.widgets.xyChart.chartOptions.withMode

withMode(mode)

"The chart mode. Possible values: MODE_UNSPECIFIED, COLOR, X_RAY, STATS"

obj spec.rowLayout.rows.widgets.xyChart.dataSets

"Required. The data displayed in this chart."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.withLegendTemplate

withLegendTemplate(legendTemplate)

"A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value. "

fn spec.rowLayout.rows.widgets.xyChart.dataSets.withMinAlignmentPeriod

withMinAlignmentPeriod(minAlignmentPeriod)

"Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.withPlotType

withPlotType(plotType)

"How this data should be plotted on the chart. Possible values: PLOT_TYPE_UNSPECIFIED, LINE, STACKED_AREA, STACKED_BAR, HEATMAP"

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery

"Required. Fields for querying time series data from the Stackdriver metrics API."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withTimeSeriesQueryLanguage

withTimeSeriesQueryLanguage(timeSeriesQueryLanguage)

"A query used to fetch time series."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.withUnitOverride

withUnitOverride(unitOverride)

"The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter

"Filter parameters to fetch time series."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation

"Apply a second aggregation after aggregation is applied."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilter.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio

"Parameters to fetch a ratio between two time series filters."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator

"The denominator of the ratio."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.denominator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator

"The numerator of the ratio."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.withFilter

withFilter(filter)

"Required. The monitoring filter that identifies the metric types, resources, and projects to query."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation

"By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.numerator.aggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter

"Ranking based time series filter."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withDirection

withDirection(direction)

"How to use the ranking to select time series that pass through the filter. Possible values: DIRECTION_UNSPECIFIED, TOP, BOTTOM"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withNumTimeSeries

withNumTimeSeries(numTimeSeries)

"How many time series to allow to pass through the filter."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.pickTimeSeriesFilter.withRankingMethod

withRankingMethod(rankingMethod)

"ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. Possible values: METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST"

obj spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation

"Apply a second aggregation after the ratio is computed."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withAlignmentPeriod

withAlignmentPeriod(alignmentPeriod)

"The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the [time series][google.monitoring.v3.TimeSeries] into consistent blocks of time. This will be done before the per-series aligner can be applied to the data. The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withCrossSeriesReducer

withCrossSeriesReducer(crossSeriesReducer)

"The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series. Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series. Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. Possible values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN, REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION"

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFields

withGroupByFields(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withGroupByFieldsMixin

withGroupByFieldsMixin(groupByFields)

"The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored."

Note: This function appends passed data to existing values

fn spec.rowLayout.rows.widgets.xyChart.dataSets.timeSeriesQuery.timeSeriesFilterRatio.secondaryAggregation.withPerSeriesAligner

withPerSeriesAligner(perSeriesAligner)

"An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period. Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned."

obj spec.rowLayout.rows.widgets.xyChart.thresholds

"Threshold lines drawn horizontally across the chart."

fn spec.rowLayout.rows.widgets.xyChart.thresholds.withColor

withColor(color)

"The state color for this threshold. Color is not allowed in a XyChart. Possible values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN, YELLOW, ORANGE, RED"

fn spec.rowLayout.rows.widgets.xyChart.thresholds.withDirection

withDirection(direction)

"The direction for the current threshold. Direction is not allowed in a XyChart. Possible values: DIRECTION_UNSPECIFIED, ABOVE, BELOW"

fn spec.rowLayout.rows.widgets.xyChart.thresholds.withLabel

withLabel(label)

"A label for the threshold."

fn spec.rowLayout.rows.widgets.xyChart.thresholds.withValue

withValue(value)

"The value of the threshold. The value should be defined in the native scale of the metric."

obj spec.rowLayout.rows.widgets.xyChart.xAxis

"The properties applied to the X axis."

fn spec.rowLayout.rows.widgets.xyChart.xAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.rowLayout.rows.widgets.xyChart.xAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"

obj spec.rowLayout.rows.widgets.xyChart.yAxis

"The properties applied to the Y axis."

fn spec.rowLayout.rows.widgets.xyChart.yAxis.withLabel

withLabel(label)

"The label of the axis."

fn spec.rowLayout.rows.widgets.xyChart.yAxis.withScale

withScale(scale)

"The axis scale. By default, a linear scale is used. Possible values: SCALE_UNSPECIFIED, LINEAR, LOG10"