Copyright | (c) 2015-2016 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- OAuth Scopes
- MetricDescriptorValueType
- MonitoredResourceDescriptor
- CollectdValueDataSourceType
- ListTimeSeriesResponse
- ListMetricAssociationsResponse
- MetricDescriptor
- Group
- TypedValue
- MonitoredResourceLabels
- SourceContext
- Distribution
- Field
- FieldKind
- MetricAssociation
- Empty
- ListGroupsResponse
- ListMetricDescriptorsResponse
- OptionValue
- Category
- CreateTimeSeriesRequest
- ListMonitoredResourceDescriptorsResponse
- LabelDescriptorValueType
- Explicit
- MetricLabels
- CollectdPayloadMetadata
- CollectdValue
- CreateCollectdTimeSeriesRequest
- TypeSyntax
- Point
- CollectdPayload
- Metric
- Exponential
- ListCategoriesResponse
- Range
- MonitoredResource
- Xgafv
- TimeInterval
- TimeSeriesMetricKind
- ListGroupMembersResponse
- LabelDescriptor
- TimeSeriesValueType
- Linear
- FieldCardinality
- Type
- MetricDescriptorMetricKind
- Option
- BucketOptions
- TimeSeries
- monitoringService :: ServiceConfig
- monitoringReadScope :: Proxy '["https://www.googleapis.com/auth/monitoring.read"]
- cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"]
- monitoringScope :: Proxy '["https://www.googleapis.com/auth/monitoring"]
- monitoringWriteScope :: Proxy '["https://www.googleapis.com/auth/monitoring.write"]
- data MetricDescriptorValueType
- data MonitoredResourceDescriptor
- monitoredResourceDescriptor :: MonitoredResourceDescriptor
- mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor]
- mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text)
- mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text)
- data CollectdValueDataSourceType
- data ListTimeSeriesResponse
- listTimeSeriesResponse :: ListTimeSeriesResponse
- ltsrNextPageToken :: Lens' ListTimeSeriesResponse (Maybe Text)
- ltsrTimeSeries :: Lens' ListTimeSeriesResponse [TimeSeries]
- data ListMetricAssociationsResponse
- listMetricAssociationsResponse :: ListMetricAssociationsResponse
- lmarNextPageToken :: Lens' ListMetricAssociationsResponse (Maybe Text)
- lmarMetricAssociations :: Lens' ListMetricAssociationsResponse [MetricAssociation]
- data MetricDescriptor
- metricDescriptor :: MetricDescriptor
- mdMetricKind :: Lens' MetricDescriptor (Maybe MetricDescriptorMetricKind)
- mdName :: Lens' MetricDescriptor (Maybe Text)
- mdDisplayName :: Lens' MetricDescriptor (Maybe Text)
- mdLabels :: Lens' MetricDescriptor [LabelDescriptor]
- mdType :: Lens' MetricDescriptor (Maybe Text)
- mdValueType :: Lens' MetricDescriptor (Maybe MetricDescriptorValueType)
- mdDescription :: Lens' MetricDescriptor (Maybe Text)
- mdUnit :: Lens' MetricDescriptor (Maybe Text)
- data Group
- group' :: Group
- gName :: Lens' Group (Maybe Text)
- gDisplayName :: Lens' Group (Maybe Text)
- gFilter :: Lens' Group (Maybe Text)
- gIsCluster :: Lens' Group (Maybe Bool)
- gParentName :: Lens' Group (Maybe Text)
- data TypedValue
- typedValue :: TypedValue
- tvBoolValue :: Lens' TypedValue (Maybe Bool)
- tvDoubleValue :: Lens' TypedValue (Maybe Double)
- tvStringValue :: Lens' TypedValue (Maybe Text)
- tvDistributionValue :: Lens' TypedValue (Maybe Distribution)
- tvInt64Value :: Lens' TypedValue (Maybe Int64)
- data MonitoredResourceLabels
- monitoredResourceLabels :: HashMap Text Text -> MonitoredResourceLabels
- mrlAddtional :: Lens' MonitoredResourceLabels (HashMap Text Text)
- data SourceContext
- sourceContext :: SourceContext
- scFileName :: Lens' SourceContext (Maybe Text)
- data Distribution
- distribution :: Distribution
- dSumOfSquaredDeviation :: Lens' Distribution (Maybe Double)
- dMean :: Lens' Distribution (Maybe Double)
- dCount :: Lens' Distribution (Maybe Int64)
- dBucketCounts :: Lens' Distribution [Int64]
- dRange :: Lens' Distribution (Maybe Range)
- dBucketOptions :: Lens' Distribution (Maybe BucketOptions)
- data Field
- field :: Field
- fKind :: Lens' Field (Maybe FieldKind)
- fOneofIndex :: Lens' Field (Maybe Int32)
- fName :: Lens' Field (Maybe Text)
- fJSONName :: Lens' Field (Maybe Text)
- fCardinality :: Lens' Field (Maybe FieldCardinality)
- fOptions :: Lens' Field [Option]
- fPacked :: Lens' Field (Maybe Bool)
- fDefaultValue :: Lens' Field (Maybe Text)
- fNumber :: Lens' Field (Maybe Int32)
- fTypeURL :: Lens' Field (Maybe Text)
- data FieldKind
- data MetricAssociation
- metricAssociation :: MetricAssociation
- maMetricType :: Lens' MetricAssociation (Maybe Text)
- maName :: Lens' MetricAssociation (Maybe Text)
- maIsDefault :: Lens' MetricAssociation (Maybe Bool)
- data Empty
- empty :: Empty
- data ListGroupsResponse
- listGroupsResponse :: ListGroupsResponse
- lgrNextPageToken :: Lens' ListGroupsResponse (Maybe Text)
- lgrGroup :: Lens' ListGroupsResponse [Group]
- data ListMetricDescriptorsResponse
- listMetricDescriptorsResponse :: ListMetricDescriptorsResponse
- lmdrMetricDescriptors :: Lens' ListMetricDescriptorsResponse [MetricDescriptor]
- lmdrNextPageToken :: Lens' ListMetricDescriptorsResponse (Maybe Text)
- data OptionValue
- optionValue :: HashMap Text JSONValue -> OptionValue
- ovAddtional :: Lens' OptionValue (HashMap Text JSONValue)
- data Category
- category :: Category
- cShortName :: Lens' Category (Maybe Text)
- cName :: Lens' Category (Maybe Text)
- cDisplayName :: Lens' Category (Maybe Text)
- cDescription :: Lens' Category (Maybe Text)
- cIsDefault :: Lens' Category (Maybe Bool)
- data CreateTimeSeriesRequest
- createTimeSeriesRequest :: CreateTimeSeriesRequest
- ctsrTimeSeries :: Lens' CreateTimeSeriesRequest [TimeSeries]
- data ListMonitoredResourceDescriptorsResponse
- listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse
- lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text)
- lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor]
- data LabelDescriptorValueType
- data Explicit
- explicit :: Explicit
- eBounds :: Lens' Explicit [Double]
- data MetricLabels
- metricLabels :: HashMap Text Text -> MetricLabels
- mlAddtional :: Lens' MetricLabels (HashMap Text Text)
- data CollectdPayloadMetadata
- collectdPayloadMetadata :: HashMap Text TypedValue -> CollectdPayloadMetadata
- cpmAddtional :: Lens' CollectdPayloadMetadata (HashMap Text TypedValue)
- data CollectdValue
- collectdValue :: CollectdValue
- cvDataSourceName :: Lens' CollectdValue (Maybe Text)
- cvDataSourceType :: Lens' CollectdValue (Maybe CollectdValueDataSourceType)
- cvValue :: Lens' CollectdValue (Maybe TypedValue)
- data CreateCollectdTimeSeriesRequest
- createCollectdTimeSeriesRequest :: CreateCollectdTimeSeriesRequest
- cctsrCollectdPayloads :: Lens' CreateCollectdTimeSeriesRequest [CollectdPayload]
- cctsrResource :: Lens' CreateCollectdTimeSeriesRequest (Maybe MonitoredResource)
- cctsrCollectdVersion :: Lens' CreateCollectdTimeSeriesRequest (Maybe Text)
- data TypeSyntax
- data Point
- point :: Point
- pValue :: Lens' Point (Maybe TypedValue)
- pInterval :: Lens' Point (Maybe TimeInterval)
- data CollectdPayload
- collectdPayload :: CollectdPayload
- cpStartTime :: Lens' CollectdPayload (Maybe UTCTime)
- cpPluginInstance :: Lens' CollectdPayload (Maybe Text)
- cpValues :: Lens' CollectdPayload [CollectdValue]
- cpTypeInstance :: Lens' CollectdPayload (Maybe Text)
- cpEndTime :: Lens' CollectdPayload (Maybe UTCTime)
- cpMetadata :: Lens' CollectdPayload (Maybe CollectdPayloadMetadata)
- cpType :: Lens' CollectdPayload (Maybe Text)
- cpPlugin :: Lens' CollectdPayload (Maybe Text)
- data Metric
- metric :: Metric
- mLabels :: Lens' Metric (Maybe MetricLabels)
- mType :: Lens' Metric (Maybe Text)
- data Exponential
- exponential :: Exponential
- eGrowthFactor :: Lens' Exponential (Maybe Double)
- eScale :: Lens' Exponential (Maybe Double)
- eNumFiniteBuckets :: Lens' Exponential (Maybe Int32)
- data ListCategoriesResponse
- listCategoriesResponse :: ListCategoriesResponse
- lcrNextPageToken :: Lens' ListCategoriesResponse (Maybe Text)
- lcrCategory :: Lens' ListCategoriesResponse [Category]
- data Range
- range :: Range
- rMax :: Lens' Range (Maybe Double)
- rMin :: Lens' Range (Maybe Double)
- data MonitoredResource
- monitoredResource :: MonitoredResource
- mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels)
- mrType :: Lens' MonitoredResource (Maybe Text)
- data Xgafv
- data TimeInterval
- timeInterval :: TimeInterval
- tiStartTime :: Lens' TimeInterval (Maybe UTCTime)
- tiEndTime :: Lens' TimeInterval (Maybe UTCTime)
- data TimeSeriesMetricKind
- data ListGroupMembersResponse
- listGroupMembersResponse :: ListGroupMembersResponse
- lgmrNextPageToken :: Lens' ListGroupMembersResponse (Maybe Text)
- lgmrMembers :: Lens' ListGroupMembersResponse [MonitoredResource]
- lgmrTotalSize :: Lens' ListGroupMembersResponse (Maybe Int32)
- data LabelDescriptor
- labelDescriptor :: LabelDescriptor
- ldKey :: Lens' LabelDescriptor (Maybe Text)
- ldValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType)
- ldDescription :: Lens' LabelDescriptor (Maybe Text)
- data TimeSeriesValueType
- data Linear
- linear :: Linear
- lOffSet :: Lens' Linear (Maybe Double)
- lWidth :: Lens' Linear (Maybe Double)
- lNumFiniteBuckets :: Lens' Linear (Maybe Int32)
- data FieldCardinality
- data Type
- type' :: Type
- tSourceContext :: Lens' Type (Maybe SourceContext)
- tOneofs :: Lens' Type [Text]
- tName :: Lens' Type (Maybe Text)
- tOptions :: Lens' Type [Option]
- tFields :: Lens' Type [Field]
- tSyntax :: Lens' Type (Maybe TypeSyntax)
- data MetricDescriptorMetricKind
- data Option
- option :: Option
- oValue :: Lens' Option (Maybe OptionValue)
- oName :: Lens' Option (Maybe Text)
- data BucketOptions
- bucketOptions :: BucketOptions
- boExponentialBuckets :: Lens' BucketOptions (Maybe Exponential)
- boLinearBuckets :: Lens' BucketOptions (Maybe Linear)
- boExplicitBuckets :: Lens' BucketOptions (Maybe Explicit)
- data TimeSeries
- timeSeries :: TimeSeries
- tsPoints :: Lens' TimeSeries [Point]
- tsMetricKind :: Lens' TimeSeries (Maybe TimeSeriesMetricKind)
- tsMetric :: Lens' TimeSeries (Maybe Metric)
- tsResource :: Lens' TimeSeries (Maybe MonitoredResource)
- tsValueType :: Lens' TimeSeries (Maybe TimeSeriesValueType)
Service Configuration
monitoringService :: ServiceConfig Source #
Default request referring to version v3
of the Stackdriver Monitoring API. This contains the host and root path used as a starting point for constructing service requests.
OAuth Scopes
monitoringReadScope :: Proxy '["https://www.googleapis.com/auth/monitoring.read"] Source #
View monitoring data for all of your Google Cloud and third-party projects
cloudPlatformScope :: Proxy '["https://www.googleapis.com/auth/cloud-platform"] Source #
View and manage your data across Google Cloud Platform services
monitoringScope :: Proxy '["https://www.googleapis.com/auth/monitoring"] Source #
View and write monitoring data for all of your Google and third-party Cloud and API projects
monitoringWriteScope :: Proxy '["https://www.googleapis.com/auth/monitoring.write"] Source #
Publish metric data to your Google Cloud projects
MetricDescriptorValueType
data MetricDescriptorValueType Source #
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
MDVTValueTypeUnspecified |
|
MDVTBool |
|
MDVTINT64 |
|
MDVTDouble |
|
MDVTString |
|
MDVTDistribution |
|
MDVTMoney |
|
MonitoredResourceDescriptor
data MonitoredResourceDescriptor Source #
An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.
See: monitoredResourceDescriptor
smart constructor.
monitoredResourceDescriptor :: MonitoredResourceDescriptor Source #
Creates a value of MonitoredResourceDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrdName :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".
mrdDisplayName :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".
mrdLabels :: Lens' MonitoredResourceDescriptor [LabelDescriptor] Source #
Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".
mrdType :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.
mrdDescription :: Lens' MonitoredResourceDescriptor (Maybe Text) Source #
Optional. A detailed description of the monitored resource type that might be used in documentation.
CollectdValueDataSourceType
data CollectdValueDataSourceType Source #
The type of measurement.
UnspecifiedDataSourceType |
|
Gauge |
|
Counter |
|
Derive |
|
Absolute |
|
ListTimeSeriesResponse
data ListTimeSeriesResponse Source #
The ListTimeSeries response.
See: listTimeSeriesResponse
smart constructor.
listTimeSeriesResponse :: ListTimeSeriesResponse Source #
Creates a value of ListTimeSeriesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ltsrNextPageToken :: Lens' ListTimeSeriesResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
ltsrTimeSeries :: Lens' ListTimeSeriesResponse [TimeSeries] Source #
One or more time series that match the filter included in the request.
ListMetricAssociationsResponse
data ListMetricAssociationsResponse Source #
The MetricAssociations response.
See: listMetricAssociationsResponse
smart constructor.
listMetricAssociationsResponse :: ListMetricAssociationsResponse Source #
Creates a value of ListMetricAssociationsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmarNextPageToken :: Lens' ListMetricAssociationsResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
lmarMetricAssociations :: Lens' ListMetricAssociationsResponse [MetricAssociation] Source #
The MetricAssociations that match the specified filters.
MetricDescriptor
data MetricDescriptor Source #
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
See: metricDescriptor
smart constructor.
metricDescriptor :: MetricDescriptor Source #
Creates a value of MetricDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mdMetricKind :: Lens' MetricDescriptor (Maybe MetricDescriptorMetricKind) Source #
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
mdName :: Lens' MetricDescriptor (Maybe Text) Source #
The resource name of the metric descriptor. Depending on the implementation, the name typically includes: (1) the parent resource name that defines the scope of the metric type or of its data; and (2) the metric's URL-encoded type, which also appears in the type field of this descriptor. For example, following is the resource name of a custom metric within the GCP project my-project-id: "projects/my-project-id/metricDescriptors/custom.googleapis.com%2Finvoice%2Fpaid%2Famount"
mdDisplayName :: Lens' MetricDescriptor (Maybe Text) Source #
A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count".
mdLabels :: Lens' MetricDescriptor [LabelDescriptor] Source #
The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
mdType :: Lens' MetricDescriptor (Maybe Text) Source #
The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "appengine.googleapis.com/http/server/response_latencies"
mdValueType :: Lens' MetricDescriptor (Maybe MetricDescriptorValueType) Source #
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
mdDescription :: Lens' MetricDescriptor (Maybe Text) Source #
A detailed description of the metric, which can be used in documentation.
mdUnit :: Lens' MetricDescriptor (Maybe Text) Source #
The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d dayPrefixes (PREFIX) k kilo (10**3) M mega (10**6) G giga (10**9) T tera (10**12) P peta (10**15) E exa (10**18) Z zetta (10**21) Y yotta (10**24) m milli (10**-3) u micro (10**-6) n nano (10**-9) p pico (10**-12) f femto (10**-15) a atto (10**-18) z zepto (10**-21) y yocto (10**-24) Ki kibi (2**10) Mi mebi (2**20) Gi gibi (2**30) Ti tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors: / division (as an infix operator, e.g. 1/s). . multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = [ PREFIX ] UNIT [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.
Group
The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: "environment" and "role". A parent group has a filter, environment="production". A child of that parent group has a filter, role="transcoder". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.
See: group'
smart constructor.
Creates a value of Group
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
gName :: Lens' Group (Maybe Text) Source #
Output only. The name of this group. The format is "projects/{project_id_or_number}/groups/{group_id}". When creating a group, this field is ignored and a new name is created consisting of the project specified in the call to CreateGroup and a unique {group_id} that is generated automatically.
gDisplayName :: Lens' Group (Maybe Text) Source #
A user-assigned name for this group, used only for display purposes.
gFilter :: Lens' Group (Maybe Text) Source #
The filter used to determine which monitored resources belong to this group.
gIsCluster :: Lens' Group (Maybe Bool) Source #
If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
gParentName :: Lens' Group (Maybe Text) Source #
The name of the group's parent, if it has one. The format is "projects/{project_id_or_number}/groups/{group_id}". For groups with no parent, parentName is the empty string, "".
TypedValue
data TypedValue Source #
A single strongly-typed value.
See: typedValue
smart constructor.
typedValue :: TypedValue Source #
Creates a value of TypedValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tvBoolValue :: Lens' TypedValue (Maybe Bool) Source #
A Boolean value: true or false.
tvDoubleValue :: Lens' TypedValue (Maybe Double) Source #
A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
tvStringValue :: Lens' TypedValue (Maybe Text) Source #
A variable-length string value.
tvDistributionValue :: Lens' TypedValue (Maybe Distribution) Source #
A distribution value.
tvInt64Value :: Lens' TypedValue (Maybe Int64) Source #
A 64-bit integer. Its range is approximately ±9.2x1018.
MonitoredResourceLabels
data MonitoredResourceLabels Source #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
See: monitoredResourceLabels
smart constructor.
monitoredResourceLabels Source #
Creates a value of MonitoredResourceLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SourceContext
data SourceContext Source #
SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
See: sourceContext
smart constructor.
sourceContext :: SourceContext Source #
Creates a value of SourceContext
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scFileName :: Lens' SourceContext (Maybe Text) Source #
The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto".
Distribution
data Distribution Source #
Distribution contains summary statistics for a population of values and, optionally, a histogram representing the distribution of those values across a specified set of histogram buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values.The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by specifying parameters for a method of computing them (buckets of fixed width or buckets of exponentially increasing width).Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.
See: distribution
smart constructor.
distribution :: Distribution Source #
Creates a value of Distribution
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dSumOfSquaredDeviation :: Lens' Distribution (Maybe Double) Source #
The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
dMean :: Lens' Distribution (Maybe Double) Source #
The arithmetic mean of the values in the population. If count is zero then this field must be zero.
dCount :: Lens' Distribution (Maybe Int64) Source #
The number of values in the population. Must be non-negative.
dBucketCounts :: Lens' Distribution [Int64] Source #
If bucket_options is given, then the sum of the values in bucket_counts must equal the value in count. If bucket_options is not given, no bucket_counts fields may be given.Bucket counts are given in order under the numbering scheme described above (the underflow bucket has number 0; the finite buckets, if any, have numbers 1 through N-2; the overflow bucket has number N-1).The size of bucket_counts must be no greater than N as defined in bucket_options.Any suffix of trailing zero bucket_count fields may be omitted.
dRange :: Lens' Distribution (Maybe Range) Source #
If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Stackdriver Monitoring API v3.
dBucketOptions :: Lens' Distribution (Maybe BucketOptions) Source #
Defines the histogram bucket boundaries.
Field
A single field of a message type.
See: field
smart constructor.
Creates a value of Field
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
fOneofIndex :: Lens' Field (Maybe Int32) Source #
The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
fCardinality :: Lens' Field (Maybe FieldCardinality) Source #
The field cardinality.
fDefaultValue :: Lens' Field (Maybe Text) Source #
The string value of the default value of this field. Proto2 syntax only.
fTypeURL :: Lens' Field (Maybe Text) Source #
The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
FieldKind
The field type.
TypeUnknown |
|
TypeDouble |
|
TypeFloat |
|
TypeINT64 |
|
TypeUINT64 |
|
TypeINT32 |
|
TypeFIXED64 |
|
TypeFIXED32 |
|
TypeBool |
|
TypeString |
|
TypeGroup |
|
TypeMessage |
|
TypeBytes |
|
TypeUINT32 |
|
TypeEnum |
|
TypeSFIXED32 |
|
TypeSFIXED64 |
|
TypeSINT32 |
|
TypeSINT64 |
|
MetricAssociation
data MetricAssociation Source #
A Vital Signs MetricAssociation, representing the inclusion of its referenced metric type within its parent category.
See: metricAssociation
smart constructor.
metricAssociation :: MetricAssociation Source #
Creates a value of MetricAssociation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
maMetricType :: Lens' MetricAssociation (Maybe Text) Source #
Resource name of the metric. It must be the full resource name. For example, "compute.googleapis.com/instance/cpu/utilization".
maIsDefault :: Lens' MetricAssociation (Maybe Bool) Source #
A flag to indicate whether this association is part of Stackdriver's default taxonomy.
Empty
A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.
See: empty
smart constructor.
ListGroupsResponse
data ListGroupsResponse Source #
The ListGroups response.
See: listGroupsResponse
smart constructor.
listGroupsResponse :: ListGroupsResponse Source #
Creates a value of ListGroupsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgrNextPageToken :: Lens' ListGroupsResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
ListMetricDescriptorsResponse
data ListMetricDescriptorsResponse Source #
The ListMetricDescriptors response.
See: listMetricDescriptorsResponse
smart constructor.
listMetricDescriptorsResponse :: ListMetricDescriptorsResponse Source #
Creates a value of ListMetricDescriptorsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmdrMetricDescriptors :: Lens' ListMetricDescriptorsResponse [MetricDescriptor] Source #
The metric descriptors that are available to the project and that match the value of filter, if present.
lmdrNextPageToken :: Lens' ListMetricDescriptorsResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
OptionValue
data OptionValue Source #
The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
See: optionValue
smart constructor.
Creates a value of OptionValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ovAddtional :: Lens' OptionValue (HashMap Text JSONValue) Source #
Properties of the object. Contains field 'type with type URL.
Category
A Vital Signs Category.
See: category
smart constructor.
Creates a value of Category
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cShortName :: Lens' Category (Maybe Text) Source #
Unique usually one-word name for this category. e.g. latency or custom:goodness
cName :: Lens' Category (Maybe Text) Source #
Resource name for the category. e.g. projects/91091/categories/latency or projects/91091/categories/custom:goodness
cDescription :: Lens' Category (Maybe Text) Source #
A human-readable description for the category. The description can be longer and contain more details.
cIsDefault :: Lens' Category (Maybe Bool) Source #
A flag to indicate whether this category is part of Stackdriver's default taxonomy.
CreateTimeSeriesRequest
data CreateTimeSeriesRequest Source #
The CreateTimeSeries request.
See: createTimeSeriesRequest
smart constructor.
createTimeSeriesRequest :: CreateTimeSeriesRequest Source #
Creates a value of CreateTimeSeriesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ctsrTimeSeries :: Lens' CreateTimeSeriesRequest [TimeSeries] Source #
The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.
ListMonitoredResourceDescriptorsResponse
data ListMonitoredResourceDescriptorsResponse Source #
The ListMonitoredResourcDescriptors response.
See: listMonitoredResourceDescriptorsResponse
smart constructor.
listMonitoredResourceDescriptorsResponse :: ListMonitoredResourceDescriptorsResponse Source #
Creates a value of ListMonitoredResourceDescriptorsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lmrdrNextPageToken :: Lens' ListMonitoredResourceDescriptorsResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
lmrdrResourceDescriptors :: Lens' ListMonitoredResourceDescriptorsResponse [MonitoredResourceDescriptor] Source #
The monitored resource descriptors that are available to this project and that match filter, if present.
LabelDescriptorValueType
data LabelDescriptorValueType Source #
The type of data that can be assigned to the label.
String |
|
Bool |
|
INT64 |
|
Explicit
A set of buckets with arbitrary widths.Defines size(bounds) + 1 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1There must be at least one element in bounds. If bounds has only one element, there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
See: explicit
smart constructor.
MetricLabels
data MetricLabels Source #
The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.
See: metricLabels
smart constructor.
Creates a value of MetricLabels
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CollectdPayloadMetadata
data CollectdPayloadMetadata Source #
The measurement metadata. Example: "process_id" -> 12345
See: collectdPayloadMetadata
smart constructor.
collectdPayloadMetadata Source #
Creates a value of CollectdPayloadMetadata
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
CollectdValue
data CollectdValue Source #
A single data point from a collectd-based plugin.
See: collectdValue
smart constructor.
collectdValue :: CollectdValue Source #
Creates a value of CollectdValue
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cvDataSourceName :: Lens' CollectdValue (Maybe Text) Source #
The data source for the collectd value. For example there are two data sources for network measurements: "rx" and "tx".
cvDataSourceType :: Lens' CollectdValue (Maybe CollectdValueDataSourceType) Source #
The type of measurement.
cvValue :: Lens' CollectdValue (Maybe TypedValue) Source #
The measurement value.
CreateCollectdTimeSeriesRequest
data CreateCollectdTimeSeriesRequest Source #
The CreateCollectdTimeSeries request.
See: createCollectdTimeSeriesRequest
smart constructor.
createCollectdTimeSeriesRequest :: CreateCollectdTimeSeriesRequest Source #
Creates a value of CreateCollectdTimeSeriesRequest
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cctsrCollectdPayloads :: Lens' CreateCollectdTimeSeriesRequest [CollectdPayload] Source #
The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of the fields plugin, plugin_instance, type, and type_instance.
cctsrResource :: Lens' CreateCollectdTimeSeriesRequest (Maybe MonitoredResource) Source #
The monitored resource associated with the time series.
cctsrCollectdVersion :: Lens' CreateCollectdTimeSeriesRequest (Maybe Text) Source #
The version of collectd that collected the data. Example: "5.3.0-192.el6".
TypeSyntax
data TypeSyntax Source #
The source syntax.
SyntaxPROTO2 |
|
SyntaxPROTO3 |
|
Point
A single data point in a time series.
See: point
smart constructor.
pInterval :: Lens' Point (Maybe TimeInterval) Source #
The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points.
CollectdPayload
data CollectdPayload Source #
A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.
See: collectdPayload
smart constructor.
collectdPayload :: CollectdPayload Source #
Creates a value of CollectdPayload
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cpStartTime :: Lens' CollectdPayload (Maybe UTCTime) Source #
The start time of the interval.
cpPluginInstance :: Lens' CollectdPayload (Maybe Text) Source #
The instance name of the plugin Example: "hdcl".
cpValues :: Lens' CollectdPayload [CollectdValue] Source #
The measured values during this time interval. Each value must have a different dataSourceName.
cpTypeInstance :: Lens' CollectdPayload (Maybe Text) Source #
The measurement type instance. Example: "used".
cpMetadata :: Lens' CollectdPayload (Maybe CollectdPayloadMetadata) Source #
The measurement metadata. Example: "process_id" -> 12345
Metric
A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.
See: metric
smart constructor.
mLabels :: Lens' Metric (Maybe MetricLabels) Source #
The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.
mType :: Lens' Metric (Maybe Text) Source #
An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.
Exponential
data Exponential Source #
Specify a sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i). Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
See: exponential
smart constructor.
exponential :: Exponential Source #
Creates a value of Exponential
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eGrowthFactor :: Lens' Exponential (Maybe Double) Source #
Must be greater than 1.
eNumFiniteBuckets :: Lens' Exponential (Maybe Int32) Source #
Must be greater than 0.
ListCategoriesResponse
data ListCategoriesResponse Source #
The ListCategories response.
See: listCategoriesResponse
smart constructor.
listCategoriesResponse :: ListCategoriesResponse Source #
Creates a value of ListCategoriesResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lcrNextPageToken :: Lens' ListCategoriesResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
lcrCategory :: Lens' ListCategoriesResponse [Category] Source #
The Categories that match the specified filters.
Range
The range of the population values.
See: range
smart constructor.
MonitoredResource
data MonitoredResource Source #
An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "instance_id" and "zone": { "type": "gce_instance", "labels": { "instance_id": "12345678901234", "zone": "us-central1-a" }}
See: monitoredResource
smart constructor.
monitoredResource :: MonitoredResource Source #
Creates a value of MonitoredResource
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
mrLabels :: Lens' MonitoredResource (Maybe MonitoredResourceLabels) Source #
Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Cloud SQL databases use the labels "database_id" and "zone".
mrType :: Lens' MonitoredResource (Maybe Text) Source #
Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Cloud SQL database is "cloudsql_database".
Xgafv
V1 error format.
TimeInterval
data TimeInterval Source #
A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.
See: timeInterval
smart constructor.
timeInterval :: TimeInterval Source #
Creates a value of TimeInterval
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tiStartTime :: Lens' TimeInterval (Maybe UTCTime) Source #
Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.
TimeSeriesMetricKind
data TimeSeriesMetricKind Source #
The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
TSMKMetricKindUnspecified |
|
TSMKGauge |
|
TSMKDelta |
|
TSMKCumulative |
|
ListGroupMembersResponse
data ListGroupMembersResponse Source #
The ListGroupMembers response.
See: listGroupMembersResponse
smart constructor.
listGroupMembersResponse :: ListGroupMembersResponse Source #
Creates a value of ListGroupMembersResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lgmrNextPageToken :: Lens' ListGroupMembersResponse (Maybe Text) Source #
If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.
lgmrMembers :: Lens' ListGroupMembersResponse [MonitoredResource] Source #
A set of monitored resources in the group.
lgmrTotalSize :: Lens' ListGroupMembersResponse (Maybe Int32) Source #
The total number of elements matching this request.
LabelDescriptor
data LabelDescriptor Source #
A description of a label.
See: labelDescriptor
smart constructor.
labelDescriptor :: LabelDescriptor Source #
Creates a value of LabelDescriptor
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ldValueType :: Lens' LabelDescriptor (Maybe LabelDescriptorValueType) Source #
The type of data that can be assigned to the label.
ldDescription :: Lens' LabelDescriptor (Maybe Text) Source #
A human-readable description for the label.
TimeSeriesValueType
data TimeSeriesValueType Source #
The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
TSVTValueTypeUnspecified |
|
TSVTBool |
|
TSVTINT64 |
|
TSVTDouble |
|
TSVTString |
|
TSVTDistribution |
|
TSVTMoney |
|
Linear
Specify a sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.Defines num_finite_buckets + 2 (= N) buckets with these boundaries for bucket i:Upper bound (0 <= i < N-1): offset + (width * i). Lower bound (1 <= i < N): offset + (width * (i - 1)).
See: linear
smart constructor.
Creates a value of Linear
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
FieldCardinality
data FieldCardinality Source #
The field cardinality.
CardinalityUnknown |
|
CardinalityOptional |
|
CardinalityRequired |
|
CardinalityRepeated |
|
Type
A protocol buffer message type.
See: type'
smart constructor.
tSourceContext :: Lens' Type (Maybe SourceContext) Source #
The source context.
MetricDescriptorMetricKind
data MetricDescriptorMetricKind Source #
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MDMKMetricKindUnspecified |
|
MDMKGauge |
|
MDMKDelta |
|
MDMKCumulative |
|
Option
A protocol buffer option, which can be attached to a message, field, enumeration, etc.
See: option
smart constructor.
oValue :: Lens' Option (Maybe OptionValue) Source #
The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
oName :: Lens' Option (Maybe Text) Source #
The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".
BucketOptions
data BucketOptions Source #
A Distribution may optionally contain a histogram of the values in the population. The histogram is given in bucket_counts as counts of values that fall into one of a sequence of non-overlapping buckets. The sequence of buckets is described by bucket_options.A bucket specifies an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket is strictly greater than the lower bound.The sequence of N buckets for a Distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.BucketOptions describes bucket boundaries in one of three ways. Two describe the boundaries by giving parameters for a formula to generate boundaries and one gives the bucket boundaries explicitly.If bucket_options is not given, then no bucket_counts may be given.
See: bucketOptions
smart constructor.
bucketOptions :: BucketOptions Source #
Creates a value of BucketOptions
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
boExponentialBuckets :: Lens' BucketOptions (Maybe Exponential) Source #
The exponential buckets.
boLinearBuckets :: Lens' BucketOptions (Maybe Linear) Source #
The linear bucket.
boExplicitBuckets :: Lens' BucketOptions (Maybe Explicit) Source #
The explicit buckets.
TimeSeries
data TimeSeries Source #
A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.
See: timeSeries
smart constructor.
timeSeries :: TimeSeries Source #
Creates a value of TimeSeries
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tsPoints :: Lens' TimeSeries [Point] Source #
The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
tsMetricKind :: Lens' TimeSeries (Maybe TimeSeriesMetricKind) Source #
The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
tsMetric :: Lens' TimeSeries (Maybe Metric) Source #
The associated metric. A fully-specified metric used to identify the time series.
tsResource :: Lens' TimeSeries (Maybe MonitoredResource) Source #
The associated resource. A fully-specified monitored resource used to identify the time series.
tsValueType :: Lens' TimeSeries (Maybe TimeSeriesValueType) Source #
The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.