Documentation
¶
Overview ¶
Package v1alpha1 is the v1alpha1 version of the API. +groupName=metrics.aws
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( SchemeBuilder = runtime.NewSchemeBuilder(addKnownTypes) AddToScheme = SchemeBuilder.AddToScheme )
SchemeBuilder definition
var SchemeGroupVersion = schema.GroupVersion{
Group: externalmetric.GroupName,
Version: "v1alpha1",
}
SchemeGroupVersion is the group version used to register these objects
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource takes an unqualified resource and returns back a Group qualified GroupResource
Types ¶
type Dimension ¶
type Dimension struct {
// The name of the dimension.
//
// Name is a required field
Name string `json:"name"`
// The value representing the dimension measurement.
//
// Value is a required field
Value string `json:"value"`
}
Dimension expands the identity of a metric.
func (*Dimension) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dimension.
func (*Dimension) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type ExternalMetric ¶
type ExternalMetric struct {
// TypeMeta is the metadata for the resource, like kind and apiversion
meta_v1.TypeMeta `json:",inline"`
// ObjectMeta contains the metadata for the particular object (name, namespace, self link,
// labels, etc)
meta_v1.ObjectMeta `json:"metadata,omitempty"`
// Spec is the custom resource spec
Spec MetricSeriesSpec `json:"spec"`
}
ExternalMetric describes a ExternalMetric resource
func (*ExternalMetric) DeepCopy ¶
func (in *ExternalMetric) DeepCopy() *ExternalMetric
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalMetric.
func (*ExternalMetric) DeepCopyInto ¶
func (in *ExternalMetric) DeepCopyInto(out *ExternalMetric)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ExternalMetric) DeepCopyObject ¶
func (in *ExternalMetric) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type ExternalMetricList ¶
type ExternalMetricList struct {
meta_v1.TypeMeta `json:",inline"`
meta_v1.ListMeta `json:"metadata"`
Items []ExternalMetric `json:"items"`
}
ExternalMetricList is a list of ExternalMetric resources
func (*ExternalMetricList) DeepCopy ¶
func (in *ExternalMetricList) DeepCopy() *ExternalMetricList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ExternalMetricList.
func (*ExternalMetricList) DeepCopyInto ¶
func (in *ExternalMetricList) DeepCopyInto(out *ExternalMetricList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*ExternalMetricList) DeepCopyObject ¶
func (in *ExternalMetricList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type Metric ¶
type Metric struct {
// The dimensions for the metric.
Dimensions []Dimension `json:"dimensions"`
// The name of the metric.
MetricName string `json:"metricName"`
// The namespace of the metric.
Namespace string `json:"namespace"`
}
Metric represents a specific metric.
func (*Metric) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Metric.
func (*Metric) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricDataQuery ¶
type MetricDataQuery struct {
// Resources specifies how associated Kubernetes resources should be discovered for
// the given metrics.
Resources string `json:"resources"`
// The math expression to be performed on the returned data, if this structure
// is performing a math expression. For more information about metric math expressions,
// see Metric Math Syntax and Functions (http://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/using-metric-math.html#metric-math-syntax)
// in the Amazon CloudWatch User Guide.
//
// Within one MetricDataQuery structure, you must specify either Expression
// or MetricStat but not both.
Expression string `json:"expression"`
// A short name used to tie this structure to the results in the response. This
// name must be unique within a single call to GetMetricData. If you are performing
// math expressions on this set of data, this name represents that data and
// can serve as a variable in the mathematical expression. The valid characters
// are letters, numbers, and underscore. The first character must be a lowercase
// letter.
//
// Id is a required field
ID string `json:"id"`
// A human-readable label for this metric or expression. This is especially
// useful if this is an expression, so that you know what the value represents.
// If the metric or expression is shown in a CloudWatch dashboard widget, the
// label is shown. If Label is omitted, CloudWatch generates a default.
Label string `json:"label"`
// The metric to be returned, along with statistics, period, and units. Use
// this parameter only if this structure is performing a data retrieval and
// not performing a math expression on the returned data.
//
// Within one MetricDataQuery structure, you must specify either Expression
// or MetricStat but not both.
MetricStat MetricStat `json:"metricStat"`
// Indicates whether to return the time stamps and raw data values of this metric.
// If you are performing this call just to do math expressions and do not also
// need the raw data returned, you can specify False. If you omit this, the
// default of True is used.
ReturnData bool `json:"returnData"`
}
MetricDataQuery represents the query structure used in GetMetricData operation to CloudWatch API.
func (*MetricDataQuery) DeepCopy ¶
func (in *MetricDataQuery) DeepCopy() *MetricDataQuery
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricDataQuery.
func (*MetricDataQuery) DeepCopyInto ¶
func (in *MetricDataQuery) DeepCopyInto(out *MetricDataQuery)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricSeriesSpec ¶
type MetricSeriesSpec struct {
// Name specifies the series name.
Name string `json:"name"`
// Queries specify the CloudWatch metrics query to retrieve data for this series.
Queries []MetricDataQuery `json:"queries"`
}
MetricSeriesSpec contains the specification for a metric series.
func (*MetricSeriesSpec) DeepCopy ¶
func (in *MetricSeriesSpec) DeepCopy() *MetricSeriesSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricSeriesSpec.
func (*MetricSeriesSpec) DeepCopyInto ¶
func (in *MetricSeriesSpec) DeepCopyInto(out *MetricSeriesSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type MetricStat ¶
type MetricStat struct {
// The metric to return, including the metric name, namespace, and dimensions.
//
// Metric is a required field
Metric Metric `json:"metric"`
// The period to use when retrieving the metric.
//
// Period is a required field
Period int64 `json:"period"`
// The statistic to return. It can include any CloudWatch statistic or extended
// statistic.
//
// Stat is a required field
Stat string `json:"stat"`
// The unit to use for the returned data points.
Unit string `json:"unit"`
}
MetricStat defines the metric to be returned, along with the statistics, period, and units.
func (*MetricStat) DeepCopy ¶
func (in *MetricStat) DeepCopy() *MetricStat
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetricStat.
func (*MetricStat) DeepCopyInto ¶
func (in *MetricStat) DeepCopyInto(out *MetricStat)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files