Types for Stackdriver Monitoring API Client#
-
class
google.cloud.monitoring_v3.types.
Aggregation
# Describes how to combine multiple time series to provide different views of the data. Aggregation consists of an alignment step on individual time series (
alignment_period
andper_series_aligner
) followed by an optional reduction step of the data across the aligned time series (cross_series_reducer
andgroup_by_fields
). For more details, see Aggregation.-
alignment_period
# The alignment period for per-[time series][google.monitoring.v3.TimeSeries] alignment. If present,
alignmentPeriod
must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. IfperSeriesAligner
is not specified or equalsALIGN_NONE
, then this field is ignored. IfperSeriesAligner
is specified and does not equalALIGN_NONE
, then this field must be defined; otherwise an error is returned.
-
per_series_aligner
# The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If
crossSeriesReducer
is specified, thenperSeriesAligner
must be specified and not equalALIGN_NONE
andalignmentPeriod
must be specified; otherwise, an error is returned.
-
cross_series_reducer
# The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series. Time series data must be aligned in order to perform cross-time series reduction. If
crossSeriesReducer
is specified, thenperSeriesAligner
must be specified and not equalALIGN_NONE
andalignmentPeriod
must be specified; otherwise, an error is returned.
-
group_by_fields
# The set of fields to preserve when
crossSeriesReducer
is specified. ThegroupByFields
determine how the time series are partitioned into subsets prior to applying the aggregation function. 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. ThecrossSeriesReducer
is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly containsresource.type
. Fields not specified ingroupByFields
are aggregated away. IfgroupByFields
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. IfcrossSeriesReducer
is not defined, this field is ignored.
-
alignment_period
Field google.monitoring.v3.Aggregation.alignment_period
-
cross_series_reducer
Field google.monitoring.v3.Aggregation.cross_series_reducer
-
group_by_fields
Field google.monitoring.v3.Aggregation.group_by_fields
-
per_series_aligner
Field google.monitoring.v3.Aggregation.per_series_aligner
-
-
class
google.cloud.monitoring_v3.types.
AlertPolicy
# A description of the conditions under which some aspect of your system is considered to be “unhealthy” and the ways to notify people or services about this state. For an overview of alert policies, see Introduction to Alerting.
-
name
# Required if the policy exists. The resource name for this policy. The syntax is: :: projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
[ALERT_POLICY_ID]
is assigned by Stackdriver Monitoring when the policy is created. When calling the [alertPolicies.cr eate][google.monitoring.v3.AlertPolicyService.CreateAlertPolic y] method, do not include thename
field in the alerting policy passed as part of the request.
-
display_name
# A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple policies in the same project. The name is limited to 512 Unicode characters.
-
documentation
# Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand, mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
-
user_labels
# User-supplied key/value data to be used for organizing and identifying the
AlertPolicy
objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
-
conditions
# A list of conditions for the policy. The conditions are combined by AND or OR according to the
combiner
field. If the combined conditions evaluate to true, then an incident is created. A policy can have from one to six conditions.
-
combiner
# How to combine the results of multiple conditions to determine if an incident should be opened.
-
enabled
# Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
-
notification_channels
# Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each element of this array corresponds to the
name
field in each of the [NotificationChannel
][google.monitoring.v3.NotificationCha nnel] objects that are returned from the [ListNotificationCh annels
][google.monitoring.v3.NotificationChannelService.List NotificationChannels] method. The syntax of the entries in this field is: :: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
-
creation_record
# A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored.
-
mutation_record
# A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored.
-
class
Condition
# A condition is a true/false test that determines when an alerting policy should open an incident. If a condition evaluates to true, it signifies that something is wrong.
-
name
# Required if the condition exists. The unique resource name for this condition. Its syntax is: :: projects/[PROJECT_ID]/ alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
[CONDITION_ID]
is assigned by Stackdriver Monitoring when the condition is created as part of a new or updated alerting policy. When calling the [alertPolicies.create][google.monito ring.v3.AlertPolicyService.CreateAlertPolicy] method, do not include thename
field in the conditions of the requested alerting policy. Stackdriver Monitoring creates the condition identifiers and includes them in the new policy. When calling the [alertPolicies.update][google.monitoring.v3.AlertPolicySer vice.UpdateAlertPolicy] method to update a policy, including a conditionname
causes the existing condition to be updated. Conditions without names are added to the updated policy. Existing conditions are deleted if they are not updated. Best practice is to preserve[CONDITION_ID]
if you make only small changes, such as those to condition thresholds, durations, or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.
-
display_name
# A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don’t use the same display name for multiple conditions in the same policy.
-
condition
# Only one of the following condition types will be specified.
-
condition_threshold
# A condition that compares a time series against a threshold.
-
condition_absent
# A condition that checks that a time series continues to receive new data points.
-
class
MetricAbsence
# A condition type that checks that monitored resources are reporting data. The configuration defines a metric and a set of monitored resources. The predicate is considered in violation when a time series for the specified metric of a monitored resource does not include any data in the specified
duration
.-
filter
# A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the
`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__ (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
-
aggregations
# Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified. This field is similar to the one in the
`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__. It is advisable to use theListTimeSeries
method when debugging this field.
-
duration
# The amount of time that a time series must fail to report new data to be considered failing. Currently, only values that are a multiple of a minute–e.g. 60, 120, or 300 seconds–are supported. If an invalid value is given, an error will be returned. The
Duration.nanos
field is ignored.
-
trigger
# The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by
filter
andaggregations
.
-
aggregations
Field google.monitoring.v3.AlertPolicy.Condition.MetricAbsence.aggregations
-
duration
Field google.monitoring.v3.AlertPolicy.Condition.MetricAbsence.duration
-
filter
Field google.monitoring.v3.AlertPolicy.Condition.MetricAbsence.filter
-
trigger
Field google.monitoring.v3.AlertPolicy.Condition.MetricAbsence.trigger
-
-
class
MetricThreshold
# A condition type that compares a collection of time series against a threshold.
-
filter
# A filter that identifies which time series should be compared with the threshold. The filter is similar to the one that is specified in the
`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__ (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
-
aggregations
# Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resrouces). Multiple aggregations are applied in the order specified. This field is similar to the one in the
`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__. It is advisable to use theListTimeSeries
method when debugging this field.
-
denominator_filter
# A filter that identifies a time series that should be used as the denominator of a ratio that will be compared with the threshold. If a
denominator_filter
is specified, the time series specified by thefilter
field will be used as the numerator. The filter is similar to the one that is specified in the`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__ (that call is useful to verify the time series that will be retrieved / processed) and must specify the metric type and optionally may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
-
denominator_aggregations
# Specifies the alignment of data points in individual time series selected by
denominatorFilter
as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources). When computing ratios, theaggregations
anddenominator_aggregations
fields must use the same alignment period and produce time series that have the same periodicity and labels. This field is similar to the one in the`MetricService.ListTimeSeries
request </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__. It is advisable to use theListTimeSeries
method when debugging this field.
-
comparison
# The comparison to apply between the time series (indicated by
filter
andaggregation
) and the threshold (indicated bythreshold_value
). The comparison is applied on each time series, with the time series on the left-hand side and the threshold on the right-hand side. OnlyCOMPARISON_LT
andCOMPARISON_GT
are supported currently.
-
threshold_value
# A value against which to compare the time series.
-
duration
# The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute–e.g., 0, 60, 120, or 300 seconds–are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series data (which may also be affected by any alignments specified in the
aggregations
field); a good duration is long enough so that a single outlier does not generate spurious alerts, but short enough that unhealthy states are detected and alerted on quickly.
-
trigger
# The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true for any of the time series that have been identified by
filter
andaggregations
, or by the ratio, ifdenominator_filter
anddenominator_aggregations
are specified.
-
aggregations
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.aggregations
-
comparison
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.comparison
-
denominator_aggregations
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.denominator_aggregations
-
denominator_filter
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.denominator_filter
-
duration
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.duration
-
filter
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.filter
-
threshold_value
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.threshold_value
-
trigger
Field google.monitoring.v3.AlertPolicy.Condition.MetricThreshold.trigger
-
-
class
Trigger
# Specifies how many time series must fail a predicate to trigger a condition. If not specified, then a
{count: 1}
trigger is used.-
type
# A type of trigger.
-
count
# The absolute number of time series that must fail the predicate for the condition to be triggered.
-
percent
# The percentage of time series that must fail the predicate for the condition to be triggered.
-
count
Field google.monitoring.v3.AlertPolicy.Condition.Trigger.count
-
percent
Field google.monitoring.v3.AlertPolicy.Condition.Trigger.percent
-
-
condition_absent
Field google.monitoring.v3.AlertPolicy.Condition.condition_absent
-
condition_threshold
Field google.monitoring.v3.AlertPolicy.Condition.condition_threshold
-
display_name
Field google.monitoring.v3.AlertPolicy.Condition.display_name
-
name
Field google.monitoring.v3.AlertPolicy.Condition.name
-
-
class
Documentation
# A content string and a MIME type that describes the content string’s format.
-
content
# The text of the documentation, interpreted according to
mime_type
. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in UTF-8 format, whichever is smaller.
-
mime_type
# The format of the
content
field. Presently, only the value"text/markdown"
is supported. See Markdown for more information.
-
content
Field google.monitoring.v3.AlertPolicy.Documentation.content
-
mime_type
Field google.monitoring.v3.AlertPolicy.Documentation.mime_type
-
-
class
UserLabelsEntry
# -
key
# Field google.monitoring.v3.AlertPolicy.UserLabelsEntry.key
-
value
# Field google.monitoring.v3.AlertPolicy.UserLabelsEntry.value
-
-
combiner
Field google.monitoring.v3.AlertPolicy.combiner
-
conditions
Field google.monitoring.v3.AlertPolicy.conditions
-
creation_record
Field google.monitoring.v3.AlertPolicy.creation_record
-
display_name
Field google.monitoring.v3.AlertPolicy.display_name
-
documentation
Field google.monitoring.v3.AlertPolicy.documentation
-
enabled
Field google.monitoring.v3.AlertPolicy.enabled
-
mutation_record
Field google.monitoring.v3.AlertPolicy.mutation_record
-
name
Field google.monitoring.v3.AlertPolicy.name
-
notification_channels
Field google.monitoring.v3.AlertPolicy.notification_channels
-
user_labels
Field google.monitoring.v3.AlertPolicy.user_labels
-
-
class
google.cloud.monitoring_v3.types.
Any
# -
type_url
# Field google.protobuf.Any.type_url
-
value
# Field google.protobuf.Any.value
-
-
class
google.cloud.monitoring_v3.types.
CreateAlertPolicyRequest
# The protocol for the
CreateAlertPolicy
request.-
name
# The project in which to create the alerting policy. The format is
projects/[PROJECT_ID]
. Note that this field names the parent container in which the alerting policy will be written, not the name of the created policy. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a suffix of the form/alertPolicies/[POLICY_ID]
, identifying the policy in the container.
-
alert_policy
# The requested alerting policy. You should omit the
name
field in this policy. The name will be returned in the new policy, including a new [ALERT_POLICY_ID] value.
-
alert_policy
Field google.monitoring.v3.CreateAlertPolicyRequest.alert_policy
-
name
Field google.monitoring.v3.CreateAlertPolicyRequest.name
-
-
class
google.cloud.monitoring_v3.types.
CreateGroupRequest
# The
CreateGroup
request.-
name
# The project in which to create the group. The format is
"projects/{project_id_or_number}"
.
-
group
# A group definition. It is an error to define the
name
field because the system assigns the name.
-
validate_only
# If true, validate this request but do not create the group.
-
group
Field google.monitoring.v3.CreateGroupRequest.group
-
name
Field google.monitoring.v3.CreateGroupRequest.name
-
validate_only
Field google.monitoring.v3.CreateGroupRequest.validate_only
-
-
class
google.cloud.monitoring_v3.types.
CreateMetricDescriptorRequest
# The
CreateMetricDescriptor
request.-
name
# The project on which to execute the request. The format is
"projects/{project_id_or_number}"
.
-
metric_descriptor
# The new custom metric descriptor.
-
metric_descriptor
Field google.monitoring.v3.CreateMetricDescriptorRequest.metric_descriptor
-
name
Field google.monitoring.v3.CreateMetricDescriptorRequest.name
-
-
class
google.cloud.monitoring_v3.types.
CreateNotificationChannelRequest
# The
CreateNotificationChannel
request.-
name
# The project on which to execute the request. The format is: :: projects/[PROJECT_ID] Note that this names the container into which the channel will be written. This does not name the newly created channel. The resulting channel’s name will have a normalized version of this field as a prefix, but will add
/notificationChannels/[CHANNEL_ID]
to identify the channel.
-
notification_channel
# The definition of the
NotificationChannel
to create.
-
name
Field google.monitoring.v3.CreateNotificationChannelRequest.name
-
notification_channel
Field google.monitoring.v3.CreateNotificationChannelRequest.notification_channel
-
-
class
google.cloud.monitoring_v3.types.
CreateTimeSeriesError
# Describes the result of a failed request to write data to a time series.
-
time_series
# The time series, including the
Metric
,MonitoredResource
, andPoint
s (including timestamp and value) that resulted in the error. This field provides all of the context that would be needed to retry the operation.
-
status
# The status of the requested write operation.
-
status
Field google.monitoring.v3.CreateTimeSeriesError.status
-
time_series
Field google.monitoring.v3.CreateTimeSeriesError.time_series
-
-
class
google.cloud.monitoring_v3.types.
CreateTimeSeriesRequest
# The
CreateTimeSeries
request.-
name
# The project on which to execute the request. The format is
"projects/{project_id_or_number}"
.
-
time_series
# 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.
-
name
Field google.monitoring.v3.CreateTimeSeriesRequest.name
-
time_series
Field google.monitoring.v3.CreateTimeSeriesRequest.time_series
-
-
class
google.cloud.monitoring_v3.types.
CreateUptimeCheckConfigRequest
# The protocol for the
CreateUptimeCheckConfig
request.-
parent
# The project in which to create the uptime check. The format is
projects/[PROJECT_ID]
.
-
uptime_check_config
# The new uptime check configuration.
-
parent
Field google.monitoring.v3.CreateUptimeCheckConfigRequest.parent
-
uptime_check_config
Field google.monitoring.v3.CreateUptimeCheckConfigRequest.uptime_check_config
-
-
class
google.cloud.monitoring_v3.types.
DeleteAlertPolicyRequest
# The protocol for the
DeleteAlertPolicy
request.-
name
# - The alerting policy to delete. The format is: ::
projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID] For more information, see [AlertPolicy][google.monitoring.v3.AlertPolicy].
-
name
Field google.monitoring.v3.DeleteAlertPolicyRequest.name
-
-
class
google.cloud.monitoring_v3.types.
DeleteGroupRequest
# The
DeleteGroup
request. You can only delete a group if it has no children.-
name
# The group to delete. The format is
"projects/{project_id_or_number}/groups/{group_id}"
.
-
name
Field google.monitoring.v3.DeleteGroupRequest.name
-
-
class
google.cloud.monitoring_v3.types.
DeleteMetricDescriptorRequest
# The
DeleteMetricDescriptor
request.-
name
# The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors /{metric_id}"
. An example of{metric_id}
is:"custom.googleapis.com/my_test_metric"
.
-
name
Field google.monitoring.v3.DeleteMetricDescriptorRequest.name
-
-
class
google.cloud.monitoring_v3.types.
DeleteNotificationChannelRequest
# The
DeleteNotificationChannel
request.-
name
# The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
.
-
force
# If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still referenced by an existing alerting policy will fail to be deleted in a delete operation.
-
force
Field google.monitoring.v3.DeleteNotificationChannelRequest.force
-
name
Field google.monitoring.v3.DeleteNotificationChannelRequest.name
-
-
class
google.cloud.monitoring_v3.types.
DeleteUptimeCheckConfigRequest
# The protocol for the
DeleteUptimeCheckConfig
request.-
name
# The uptime check configuration to delete. The format is
proj ects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
-
name
Field google.monitoring.v3.DeleteUptimeCheckConfigRequest.name
-
-
class
google.cloud.monitoring_v3.types.
Distribution
# -
class
BucketOptions
# -
-
class
Exponential
# -
growth_factor
# Field google.api.Distribution.BucketOptions.Exponential.growth_factor
-
num_finite_buckets
# Field google.api.Distribution.BucketOptions.Exponential.num_finite_buckets
-
scale
# Field google.api.Distribution.BucketOptions.Exponential.scale
-
-
class
Linear
# -
num_finite_buckets
# Field google.api.Distribution.BucketOptions.Linear.num_finite_buckets
-
offset
# Field google.api.Distribution.BucketOptions.Linear.offset
-
width
# Field google.api.Distribution.BucketOptions.Linear.width
-
-
explicit_buckets
# Field google.api.Distribution.BucketOptions.explicit_buckets
-
exponential_buckets
# Field google.api.Distribution.BucketOptions.exponential_buckets
-
linear_buckets
# Field google.api.Distribution.BucketOptions.linear_buckets
-
class
-
class
Exemplar
# -
attachments
# Field google.api.Distribution.Exemplar.attachments
-
timestamp
# Field google.api.Distribution.Exemplar.timestamp
-
value
# Field google.api.Distribution.Exemplar.value
-
-
class
Range
# -
max
# Field google.api.Distribution.Range.max
-
min
# Field google.api.Distribution.Range.min
-
-
bucket_counts
# Field google.api.Distribution.bucket_counts
-
bucket_options
# Field google.api.Distribution.bucket_options
-
count
# Field google.api.Distribution.count
-
exemplars
# Field google.api.Distribution.exemplars
-
mean
# Field google.api.Distribution.mean
-
range
# Field google.api.Distribution.range
-
sum_of_squared_deviation
# Field google.api.Distribution.sum_of_squared_deviation
-
class
-
class
google.cloud.monitoring_v3.types.
DroppedLabels
# A set of (label, value) pairs which were dropped during aggregation, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.
These values are used in combination with the label values that remain on the aggregated Distribution timeseries to construct the full label set for the exemplar values. The resulting full label set may be used to identify the specific task/job/instance (for example) which may be contributing to a long-tail, while allowing the storage savings of only storing aggregated distribution values for a large group.
Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.
-
label
# Map from label to its value, for all labels dropped in any aggregation.
-
class
LabelEntry
# -
key
# Field google.monitoring.v3.DroppedLabels.LabelEntry.key
-
value
# Field google.monitoring.v3.DroppedLabels.LabelEntry.value
-
-
label
Field google.monitoring.v3.DroppedLabels.label
-
-
class
google.cloud.monitoring_v3.types.
Duration
# -
nanos
# Field google.protobuf.Duration.nanos
-
seconds
# Field google.protobuf.Duration.seconds
-
-
class
google.cloud.monitoring_v3.types.
Empty
#
-
class
google.cloud.monitoring_v3.types.
GetAlertPolicyRequest
# The protocol for the
GetAlertPolicy
request.-
name
# - The alerting policy to retrieve. The format is ::
projects/[PROJECT_ID]/alertPolicies/[ALERT_POLICY_ID]
-
name
Field google.monitoring.v3.GetAlertPolicyRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetGroupRequest
# The
GetGroup
request.-
name
# The group to retrieve. The format is
"projects/{project_id_or_number}/groups/{group_id}"
.
-
name
Field google.monitoring.v3.GetGroupRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetMetricDescriptorRequest
# The
GetMetricDescriptor
request.-
name
# The metric descriptor on which to execute the request. The format is
"projects/{project_id_or_number}/metricDescriptors /{metric_id}"
. An example value of{metric_id}
is"compute.googleapis.com/instance/disk/read_bytes_count"
.
-
name
Field google.monitoring.v3.GetMetricDescriptorRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetMonitoredResourceDescriptorRequest
# The
GetMonitoredResourceDescriptor
request.-
name
# The monitored resource descriptor to get. The format is
"pro jects/{project_id_or_number}/monitoredResourceDescriptors/{res ource_type}"
. The{resource_type}
is a predefined type, such ascloudsql_database
.
-
name
Field google.monitoring.v3.GetMonitoredResourceDescriptorRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetNotificationChannelDescriptorRequest
# The
GetNotificationChannelDescriptor
response.-
name
# The channel type for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannelDescriptors/{cha nnel_type}
.
-
name
Field google.monitoring.v3.GetNotificationChannelDescriptorRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetNotificationChannelRequest
# The
GetNotificationChannel
request.-
name
# The channel for which to execute the request. The format is
projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]
.
-
name
Field google.monitoring.v3.GetNotificationChannelRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetNotificationChannelVerificationCodeRequest
# The
GetNotificationChannelVerificationCode
request.-
name
# The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is not verified, the request will fail.
-
expire_time
# The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code’s lifetime over omitting an expiration, even though the API does impose an upper limit on the maximum expiration that is permitted).
-
expire_time
Field google.monitoring.v3.GetNotificationChannelVerificationCodeRequest.expire_time
-
name
Field google.monitoring.v3.GetNotificationChannelVerificationCodeRequest.name
-
-
class
google.cloud.monitoring_v3.types.
GetNotificationChannelVerificationCodeResponse
# The
GetNotificationChannelVerificationCode
request.-
code
# The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other email channels with the same email address or other sms channels with the same number).
-
expire_time
# The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the max permitted expiration.
-
code
Field google.monitoring.v3.GetNotificationChannelVerificationCodeResponse.code
-
expire_time
Field google.monitoring.v3.GetNotificationChannelVerificationCodeResponse.expire_time
-
-
class
google.cloud.monitoring_v3.types.
GetUptimeCheckConfigRequest
# The protocol for the
GetUptimeCheckConfig
request.-
name
# The uptime check configuration to retrieve. The format is
pr ojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]
.
-
name
Field google.monitoring.v3.GetUptimeCheckConfigRequest.name
-
-
class
google.cloud.monitoring_v3.types.
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.
-
name
# 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 toCreateGroup
and a unique{group_id}
that is generated automatically.
-
display_name
# A user-assigned name for this group, used only for display purposes.
-
parent_name
# 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,""
.
-
filter
# The filter used to determine which monitored resources belong to this group.
-
is_cluster
# If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters.
-
display_name
Field google.monitoring.v3.Group.display_name
-
filter
Field google.monitoring.v3.Group.filter
-
is_cluster
Field google.monitoring.v3.Group.is_cluster
-
name
Field google.monitoring.v3.Group.name
-
parent_name
Field google.monitoring.v3.Group.parent_name
-
-
class
google.cloud.monitoring_v3.types.
InternalChecker
# An internal checker allows uptime checks to run on private/internal GCP resources.
-
name
# A unique resource name for this InternalChecker. The format is:
projects/[PROJECT_ID]/internalCheckers/[INTERNAL_CHECKE R_ID]
. PROJECT_ID is the stackdriver workspace project for the uptime check config associated with the internal checker.
-
display_name
# The checker’s human-readable name. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced.
-
network
# The GCP VPC network where the internal resource lives (ex: “default”).
-
gcp_zone
# The GCP zone the uptime check should egress from. Only respected for internal uptime checks, where internal_network is specified.
-
peer_project_id
# The GCP project_id where the internal checker lives. Not necessary the same as the workspace project.
-
display_name
Field google.monitoring.v3.InternalChecker.display_name
-
gcp_zone
Field google.monitoring.v3.InternalChecker.gcp_zone
-
name
Field google.monitoring.v3.InternalChecker.name
-
network
Field google.monitoring.v3.InternalChecker.network
-
peer_project_id
Field google.monitoring.v3.InternalChecker.peer_project_id
-
-
class
google.cloud.monitoring_v3.types.
LabelDescriptor
# -
description
# Field google.api.LabelDescriptor.description
-
key
# Field google.api.LabelDescriptor.key
-
value_type
# Field google.api.LabelDescriptor.value_type
-
-
class
google.cloud.monitoring_v3.types.
ListAlertPoliciesRequest
# The protocol for the
ListAlertPolicies
request.-
name
# The project whose alert policies are to be listed. The format is :: projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the [GetAlertPolicy][google.monitoring.v3.AlertPolic yService.GetAlertPolicy] operation, instead.
-
filter
# If provided, this field specifies the criteria that must be met by alert policies to be included in the response. For more details, see sorting and filtering.
-
order_by
# A comma-separated list of fields by which to sort the result. Supports the same set of field references as the
filter
field. Entries can be prefixed with a minus sign to sort by the field in descending order. For more details, see sorting and filtering.
-
page_size
# The maximum number of results to return in a single response.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
-
filter
Field google.monitoring.v3.ListAlertPoliciesRequest.filter
-
name
Field google.monitoring.v3.ListAlertPoliciesRequest.name
-
order_by
Field google.monitoring.v3.ListAlertPoliciesRequest.order_by
-
page_size
Field google.monitoring.v3.ListAlertPoliciesRequest.page_size
-
page_token
Field google.monitoring.v3.ListAlertPoliciesRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListAlertPoliciesResponse
# The protocol for the
ListAlertPolicies
response.-
alert_policies
# The returned alert policies.
-
next_page_token
# If there might be more results than were 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.
-
alert_policies
Field google.monitoring.v3.ListAlertPoliciesResponse.alert_policies
-
next_page_token
Field google.monitoring.v3.ListAlertPoliciesResponse.next_page_token
-
-
class
google.cloud.monitoring_v3.types.
ListGroupMembersRequest
# The
ListGroupMembers
request.-
name
# The group whose members are listed. The format is
"projects/{project_id_or_number}/groups/{group_id}"
.
-
page_size
# A positive number that is the maximum number of results to return.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
-
filter
# An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: :: resource.type = “gce_instance”
-
interval
# An optional time interval for which results should be returned. Only members that were part of the group during the specified interval are included in the response. If no interval is provided then the group membership over the last minute is returned.
-
filter
Field google.monitoring.v3.ListGroupMembersRequest.filter
-
interval
Field google.monitoring.v3.ListGroupMembersRequest.interval
-
name
Field google.monitoring.v3.ListGroupMembersRequest.name
-
page_size
Field google.monitoring.v3.ListGroupMembersRequest.page_size
-
page_token
Field google.monitoring.v3.ListGroupMembersRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListGroupMembersResponse
# The
ListGroupMembers
response.-
members
# A set of monitored resources in the group.
-
next_page_token
# 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.
-
total_size
# The total number of elements matching this request.
-
members
Field google.monitoring.v3.ListGroupMembersResponse.members
-
next_page_token
Field google.monitoring.v3.ListGroupMembersResponse.next_page_token
-
total_size
Field google.monitoring.v3.ListGroupMembersResponse.total_size
-
-
class
google.cloud.monitoring_v3.types.
ListGroupsRequest
# The
ListGroup
request.-
name
# The project whose groups are to be listed. The format is
"projects/{project_id_or_number}"
.
-
filter
# An optional filter consisting of a single group name. The filters limit the groups returned based on their parent-child relationship with the specified group. If no filter is specified, all groups are returned.
-
children_of_group
# A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. Returns groups whoseparentName
field contains the group name. If no groups have this parent, the results are empty.
-
ancestors_of_group
# A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
-
descendants_of_group
# A group name:
"projects/{project_id_or_number}/groups/{group_id}"
. Returns the descendants of the specified group. This is a superset of the results returned by thechildrenOfGroup
filter, and includes children-of-children, and so forth.
-
page_size
# A positive number that is the maximum number of results to return.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
-
ancestors_of_group
Field google.monitoring.v3.ListGroupsRequest.ancestors_of_group
-
children_of_group
Field google.monitoring.v3.ListGroupsRequest.children_of_group
-
descendants_of_group
Field google.monitoring.v3.ListGroupsRequest.descendants_of_group
-
name
Field google.monitoring.v3.ListGroupsRequest.name
-
page_size
Field google.monitoring.v3.ListGroupsRequest.page_size
-
page_token
Field google.monitoring.v3.ListGroupsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListGroupsResponse
# The
ListGroups
response.-
group
# The groups that match the specified filters.
-
next_page_token
# 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.
-
group
Field google.monitoring.v3.ListGroupsResponse.group
-
next_page_token
Field google.monitoring.v3.ListGroupsResponse.next_page_token
-
-
class
google.cloud.monitoring_v3.types.
ListMetricDescriptorsRequest
# The
ListMetricDescriptors
request.-
name
# The project on which to execute the request. The format is
"projects/{project_id_or_number}"
.
-
filter
# If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics: :: metric.type = starts_with(“custom.googleapis.com/”)
-
page_size
# A positive number that is the maximum number of results to return.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
-
filter
Field google.monitoring.v3.ListMetricDescriptorsRequest.filter
-
name
Field google.monitoring.v3.ListMetricDescriptorsRequest.name
-
page_size
Field google.monitoring.v3.ListMetricDescriptorsRequest.page_size
-
page_token
Field google.monitoring.v3.ListMetricDescriptorsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListMetricDescriptorsResponse
# The
ListMetricDescriptors
response.-
metric_descriptors
# The metric descriptors that are available to the project and that match the value of
filter
, if present.
-
next_page_token
# 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.
-
metric_descriptors
Field google.monitoring.v3.ListMetricDescriptorsResponse.metric_descriptors
-
next_page_token
Field google.monitoring.v3.ListMetricDescriptorsResponse.next_page_token
-
-
class
google.cloud.monitoring_v3.types.
ListMonitoredResourceDescriptorsRequest
# The
ListMonitoredResourceDescriptors
request.-
name
# The project on which to execute the request. The format is
"projects/{project_id_or_number}"
.
-
filter
# An optional filter describing the descriptors to be returned. The filter can reference the descriptor’s type and labels. For example, the following filter returns only Google Compute Engine descriptors that have an
id
label:resource.type = starts_with("gce_") AND resource.label:id
-
page_size
# A positive number that is the maximum number of results to return.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
-
filter
Field google.monitoring.v3.ListMonitoredResourceDescriptorsRequest.filter
-
name
Field google.monitoring.v3.ListMonitoredResourceDescriptorsRequest.name
-
page_size
Field google.monitoring.v3.ListMonitoredResourceDescriptorsRequest.page_size
-
page_token
Field google.monitoring.v3.ListMonitoredResourceDescriptorsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListMonitoredResourceDescriptorsResponse
# The
ListMonitoredResourceDescriptors
response.-
resource_descriptors
# The monitored resource descriptors that are available to this project and that match
filter
, if present.
-
next_page_token
# 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.
-
next_page_token
Field google.monitoring.v3.ListMonitoredResourceDescriptorsResponse.next_page_token
-
resource_descriptors
Field google.monitoring.v3.ListMonitoredResourceDescriptorsResponse.resource_descriptors
-
-
class
google.cloud.monitoring_v3.types.
ListNotificationChannelDescriptorsRequest
# The
ListNotificationChannelDescriptors
request.-
name
# The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: :: projects/[PROJECT_ID] Note that this names the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the [GetNotificationChannelDesc riptor][google.monitoring.v3.NotificationChannelService.GetNot ificationChannelDescriptor] operation, instead.
-
page_size
# The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
-
page_token
# If non-empty,
page_token
must contain a value returned as thenext_page_token
in a previous response to request the next set of results.
-
name
Field google.monitoring.v3.ListNotificationChannelDescriptorsRequest.name
-
page_size
Field google.monitoring.v3.ListNotificationChannelDescriptorsRequest.page_size
-
page_token
Field google.monitoring.v3.ListNotificationChannelDescriptorsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListNotificationChannelDescriptorsResponse
# The
ListNotificationChannelDescriptors
response.-
channel_descriptors
# The monitored resource descriptors supported for the specified project, optionally filtered.
-
next_page_token
# If not empty, indicates that there may be more results that match the request. Use the value in the
page_token
field in a subsequent request to fetch the next set of results. If empty, all results have been returned.
-
channel_descriptors
Field google.monitoring.v3.ListNotificationChannelDescriptorsResponse.channel_descriptors
-
next_page_token
Field google.monitoring.v3.ListNotificationChannelDescriptorsResponse.next_page_token
-
-
class
google.cloud.monitoring_v3.types.
ListNotificationChannelsRequest
# The
ListNotificationChannels
request.-
name
# The project on which to execute the request. The format is
projects/[PROJECT_ID]
. That is, this names the container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the [GetNotificationChannel
][google.mon itoring.v3.NotificationChannelService.GetNotificationChannel] operation.
-
filter
# If provided, this field specifies the criteria that must be met by notification channels to be included in the response. For more details, see sorting and filtering.
-
order_by
# A comma-separated list of fields by which to sort the result. Supports the same set of fields as in
filter
. Entries can be prefixed with a minus sign to sort in descending rather than ascending order. For more details, see sorting and filtering.
-
page_size
# The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service.
-
page_token
# If non-empty,
page_token
must contain a value returned as thenext_page_token
in a previous response to request the next set of results.
-
filter
Field google.monitoring.v3.ListNotificationChannelsRequest.filter
-
name
Field google.monitoring.v3.ListNotificationChannelsRequest.name
-
order_by
Field google.monitoring.v3.ListNotificationChannelsRequest.order_by
-
page_size
Field google.monitoring.v3.ListNotificationChannelsRequest.page_size
-
page_token
Field google.monitoring.v3.ListNotificationChannelsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListNotificationChannelsResponse
# The
ListNotificationChannels
response.-
notification_channels
# The notification channels defined for the specified project.
-
next_page_token
# If not empty, indicates that there may be more results that match the request. Use the value in the
page_token
field in a subsequent request to fetch the next set of results. If empty, all results have been returned.
-
next_page_token
Field google.monitoring.v3.ListNotificationChannelsResponse.next_page_token
-
notification_channels
Field google.monitoring.v3.ListNotificationChannelsResponse.notification_channels
-
-
class
google.cloud.monitoring_v3.types.
ListTimeSeriesRequest
# The
ListTimeSeries
request.-
name
# The project on which to execute the request. The format is “projects/{project_id_or_number}”.
-
filter
# A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example: :: metric.type = “compute.googleapis.com/instance/cpu/usage_time” AND metric.label.instance_name = “my-instance-name”
-
interval
# The time interval for which results should be returned. Only time series that contain data points in the specified interval are included in the response.
-
aggregation
# By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
-
order_by
# Unsupported: must be left blank. The points in each time series are returned in reverse time order.
-
view
# Specifies which information is returned about the time series.
-
page_size
# A positive number that is the maximum number of results to return. If
page_size
is empty or more than 100,000 results, the effectivepage_size
is 100,000 results. Ifview
is set toFULL
, this is the maximum number ofPoints
returned. Ifview
is set toHEADERS
, this is the maximum number ofTimeSeries
returned.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
-
aggregation
Field google.monitoring.v3.ListTimeSeriesRequest.aggregation
-
filter
Field google.monitoring.v3.ListTimeSeriesRequest.filter
-
interval
Field google.monitoring.v3.ListTimeSeriesRequest.interval
-
name
Field google.monitoring.v3.ListTimeSeriesRequest.name
-
order_by
Field google.monitoring.v3.ListTimeSeriesRequest.order_by
-
page_size
Field google.monitoring.v3.ListTimeSeriesRequest.page_size
-
page_token
Field google.monitoring.v3.ListTimeSeriesRequest.page_token
-
view
Field google.monitoring.v3.ListTimeSeriesRequest.view
-
-
class
google.cloud.monitoring_v3.types.
ListTimeSeriesResponse
# The
ListTimeSeries
response.-
time_series
# One or more time series that match the filter included in the request.
-
next_page_token
# 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.
-
execution_errors
# Query execution errors that may have caused the time series data returned to be incomplete.
-
execution_errors
Field google.monitoring.v3.ListTimeSeriesResponse.execution_errors
-
next_page_token
Field google.monitoring.v3.ListTimeSeriesResponse.next_page_token
-
time_series
Field google.monitoring.v3.ListTimeSeriesResponse.time_series
-
-
class
google.cloud.monitoring_v3.types.
ListUptimeCheckConfigsRequest
# The protocol for the
ListUptimeCheckConfigs
request.-
parent
# The project whose uptime check configurations are listed. The format is
projects/[PROJECT_ID]
.
-
page_size
# The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned.
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.
-
page_size
Field google.monitoring.v3.ListUptimeCheckConfigsRequest.page_size
-
page_token
Field google.monitoring.v3.ListUptimeCheckConfigsRequest.page_token
-
parent
Field google.monitoring.v3.ListUptimeCheckConfigsRequest.parent
-
-
class
google.cloud.monitoring_v3.types.
ListUptimeCheckConfigsResponse
# The protocol for the
ListUptimeCheckConfigs
response.-
uptime_check_configs
# The returned uptime check configurations.
-
next_page_token
# This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message’s page_token field).
-
total_size
# The total number of uptime check configurations for the project, irrespective of any pagination.
-
next_page_token
Field google.monitoring.v3.ListUptimeCheckConfigsResponse.next_page_token
-
total_size
Field google.monitoring.v3.ListUptimeCheckConfigsResponse.total_size
-
uptime_check_configs
Field google.monitoring.v3.ListUptimeCheckConfigsResponse.uptime_check_configs
-
-
class
google.cloud.monitoring_v3.types.
ListUptimeCheckIpsRequest
# The protocol for the
ListUptimeCheckIps
request.-
page_size
# The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0, the server will decide the number of results to be returned. NOTE: this field is not yet implemented
-
page_token
# If this field is not empty then it must contain the
nextPageToken
value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented
-
page_size
Field google.monitoring.v3.ListUptimeCheckIpsRequest.page_size
-
page_token
Field google.monitoring.v3.ListUptimeCheckIpsRequest.page_token
-
-
class
google.cloud.monitoring_v3.types.
ListUptimeCheckIpsResponse
# The protocol for the
ListUptimeCheckIps
response.-
uptime_check_ips
# The returned list of IP addresses (including region and location) that the checkers run from.
-
next_page_token
# This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of results, the value of the next_page_token is passed to the subsequent List method call (in the request message’s page_token field). NOTE: this field is not yet implemented
-
next_page_token
Field google.monitoring.v3.ListUptimeCheckIpsResponse.next_page_token
-
uptime_check_ips
Field google.monitoring.v3.ListUptimeCheckIpsResponse.uptime_check_ips
-
-
class
google.cloud.monitoring_v3.types.
Metric
# -
class
LabelsEntry
# -
key
# Field google.api.Metric.LabelsEntry.key
-
value
# Field google.api.Metric.LabelsEntry.value
-
-
labels
# Field google.api.Metric.labels
-
type
# Field google.api.Metric.type
-
class
-
class
google.cloud.monitoring_v3.types.
MetricDescriptor
# -
class
MetricDescriptorMetadata
# -
ingest_delay
# Field google.api.MetricDescriptor.MetricDescriptorMetadata.ingest_delay
-
launch_stage
# Field google.api.MetricDescriptor.MetricDescriptorMetadata.launch_stage
-
sample_period
# Field google.api.MetricDescriptor.MetricDescriptorMetadata.sample_period
-
-
description
# Field google.api.MetricDescriptor.description
-
display_name
# Field google.api.MetricDescriptor.display_name
-
labels
# Field google.api.MetricDescriptor.labels
-
metadata
# Field google.api.MetricDescriptor.metadata
-
metric_kind
# Field google.api.MetricDescriptor.metric_kind
-
name
# Field google.api.MetricDescriptor.name
-
type
# Field google.api.MetricDescriptor.type
-
unit
# Field google.api.MetricDescriptor.unit
-
value_type
# Field google.api.MetricDescriptor.value_type
-
class
-
class
google.cloud.monitoring_v3.types.
MonitoredResource
# -
class
LabelsEntry
# -
key
# Field google.api.MonitoredResource.LabelsEntry.key
-
value
# Field google.api.MonitoredResource.LabelsEntry.value
-
-
labels
# Field google.api.MonitoredResource.labels
-
type
# Field google.api.MonitoredResource.type
-
class
-
class
google.cloud.monitoring_v3.types.
MonitoredResourceDescriptor
# -
description
# Field google.api.MonitoredResourceDescriptor.description
-
display_name
# Field google.api.MonitoredResourceDescriptor.display_name
-
labels
# Field google.api.MonitoredResourceDescriptor.labels
-
name
# Field google.api.MonitoredResourceDescriptor.name
-
type
# Field google.api.MonitoredResourceDescriptor.type
-
-
class
google.cloud.monitoring_v3.types.
MonitoredResourceMetadata
# -
class
UserLabelsEntry
# -
key
# Field google.api.MonitoredResourceMetadata.UserLabelsEntry.key
-
value
# Field google.api.MonitoredResourceMetadata.UserLabelsEntry.value
-
-
system_labels
# Field google.api.MonitoredResourceMetadata.system_labels
-
user_labels
# Field google.api.MonitoredResourceMetadata.user_labels
-
class
-
class
google.cloud.monitoring_v3.types.
MutationRecord
# Describes a change made to a configuration.
-
mutate_time
# When the change occurred.
-
mutated_by
# The email address of the user making the change.
-
mutate_time
Field google.monitoring.v3.MutationRecord.mutate_time
-
mutated_by
Field google.monitoring.v3.MutationRecord.mutated_by
-
-
class
google.cloud.monitoring_v3.types.
NotificationChannel
# A
NotificationChannel
is a medium through which an alert is delivered when a policy violation is detected. Examples of channels include email, SMS, and third-party messaging applications. Fields containing sensitive information like authentication tokens or contact info are only partially populated on retrieval.-
type
# The type of the notification channel. This field matches the value of the [NotificationChannelDescriptor.type][google.monit oring.v3.NotificationChannelDescriptor.type] field.
-
name
# The full REST resource name for this channel. The syntax is: :: projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID] The
[CHANNEL_ID]
is automatically assigned by the server on creation.
-
display_name
# An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in your project, though this is not enforced. The display name is limited to 512 Unicode characters.
-
description
# An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceeed 1024 Unicode characters.
-
labels
# Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the [Noti ficationChannelDescriptor.labels][google.monitoring.v3.Notific ationChannelDescriptor.labels] of the
NotificationChannelDescriptor
corresponding to thetype
field.
-
user_labels
# User-supplied key/value data that does not need to conform to the corresponding
NotificationChannelDescriptor
’s schema, unlike thelabels
field. This field is intended to be used for organizing and identifying theNotificationChannel
objects. The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
-
verification_status
# Indicates whether this channel has been verified or not. On a [
ListNotificationChannels
][google.monitoring.v3.Notificati onChannelService.ListNotificationChannels] or [GetNotificati onChannel
][google.monitoring.v3.NotificationChannelService.G etNotificationChannel] operation, this field is expected to be populated. If the value isUNVERIFIED
, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works. If the channel is neitherVERIFIED
norUNVERIFIED
, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from verification because it was created prior to verification being required for channels of this type. This field cannot be modified using a standard [UpdateNotificationChannel
][google.monitoring.v3. NotificationChannelService.UpdateNotificationChannel] operation. To change the value of this field, you must call [` VerifyNotificationChannel`][google.monitoring.v3.Notificatio nChannelService.VerifyNotificationChannel].
-
enabled
# Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting policies on the channel at some point in the future.
-
class
LabelsEntry
# -
key
# Field google.monitoring.v3.NotificationChannel.LabelsEntry.key
-
value
# Field google.monitoring.v3.NotificationChannel.LabelsEntry.value
-
-
class
UserLabelsEntry
# -
key
# Field google.monitoring.v3.NotificationChannel.UserLabelsEntry.key
-
value
# Field google.monitoring.v3.NotificationChannel.UserLabelsEntry.value
-
-
description
Field google.monitoring.v3.NotificationChannel.description
-
display_name
Field google.monitoring.v3.NotificationChannel.display_name
-
enabled
Field google.monitoring.v3.NotificationChannel.enabled
-
labels
Field google.monitoring.v3.NotificationChannel.labels
-
name
Field google.monitoring.v3.NotificationChannel.name
-
type
Field google.monitoring.v3.NotificationChannel.type
-
user_labels
Field google.monitoring.v3.NotificationChannel.user_labels
-
verification_status
Field google.monitoring.v3.NotificationChannel.verification_status
-
-
class
google.cloud.monitoring_v3.types.
NotificationChannelDescriptor
# A description of a notification channel. The descriptor includes the properties of the channel and the set of labels or fields that must be specified to configure channels of a given type.
-
name
# The full REST resource name for this descriptor. The syntax is: :: projects/[PROJECT_ID]/notificationChannelDescriptors/[TYPE] In the above,
[TYPE]
is the value of thetype
field.
-
type
# The type of notification channel, such as “email”, “sms”, etc. Notification channel types are globally unique.
-
display_name
# A human-readable name for the notification channel type. This form of the name is suitable for a user interface.
-
description
# A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation.
-
labels
# The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated.
-
supported_tiers
# The tiers that support this notification channel; the project service tier must be one of the supported_tiers.
-
description
Field google.monitoring.v3.NotificationChannelDescriptor.description
-
display_name
Field google.monitoring.v3.NotificationChannelDescriptor.display_name
-
labels
Field google.monitoring.v3.NotificationChannelDescriptor.labels
-
name
Field google.monitoring.v3.NotificationChannelDescriptor.name
-
supported_tiers
Field google.monitoring.v3.NotificationChannelDescriptor.supported_tiers
-
type
Field google.monitoring.v3.NotificationChannelDescriptor.type
-
-
class
google.cloud.monitoring_v3.types.
Point
# A single data point in a time series.
-
interval
# The time interval to which the data point applies. For
GAUGE
metrics, only the end time of the interval is used. ForDELTA
metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. ForCUMULATIVE
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.
-
value
# The value of the data point.
-
interval
Field google.monitoring.v3.Point.interval
-
value
Field google.monitoring.v3.Point.value
-
-
class
google.cloud.monitoring_v3.types.
SendNotificationChannelVerificationCodeRequest
# The
SendNotificationChannelVerificationCode
request.-
name
# The notification channel to which to send a verification code.
-
name
Field google.monitoring.v3.SendNotificationChannelVerificationCodeRequest.name
-
-
class
google.cloud.monitoring_v3.types.
SpanContext
# The context of a span, attached to google.api.Distribution.Exemplars in google.api.Distribution values during aggregation.
It contains the name of a span with format: projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID]
-
span_name
# - The resource name of the span in the following format: ::
projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array. [SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.
-
span_name
Field google.monitoring.v3.SpanContext.span_name
-
-
class
google.cloud.monitoring_v3.types.
Status
# -
code
# Field google.rpc.Status.code
-
details
# Field google.rpc.Status.details
-
message
# Field google.rpc.Status.message
-
-
class
google.cloud.monitoring_v3.types.
Struct
# -
class
FieldsEntry
# -
key
# Field google.protobuf.Struct.FieldsEntry.key
-
value
# Field google.protobuf.Struct.FieldsEntry.value
-
-
fields
# Field google.protobuf.Struct.fields
-
class
-
class
google.cloud.monitoring_v3.types.
TimeInterval
# 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.
-
end_time
# Required. The end of the time interval.
-
start_time
# 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.
-
end_time
Field google.monitoring.v3.TimeInterval.end_time
-
start_time
Field google.monitoring.v3.TimeInterval.start_time
-
-
class
google.cloud.monitoring_v3.types.
TimeSeries
# 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.
-
metric
# The associated metric. A fully-specified metric used to identify the time series.
-
resource
# The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data.
-
metadata
# Output only. The associated monitored resource metadata. When reading a a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored.
-
metric_kind
# 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) orCUMULATIVE
.
-
value_type
# 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.
-
points
# The data points of this time series. When listing time series, points are returned in reverse time order. 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
, orDISTRIBUTION
.
-
metadata
Field google.monitoring.v3.TimeSeries.metadata
-
metric
Field google.monitoring.v3.TimeSeries.metric
-
metric_kind
Field google.monitoring.v3.TimeSeries.metric_kind
-
points
Field google.monitoring.v3.TimeSeries.points
-
resource
Field google.monitoring.v3.TimeSeries.resource
-
value_type
Field google.monitoring.v3.TimeSeries.value_type
-
-
class
google.cloud.monitoring_v3.types.
Timestamp
# -
nanos
# Field google.protobuf.Timestamp.nanos
-
seconds
# Field google.protobuf.Timestamp.seconds
-
-
class
google.cloud.monitoring_v3.types.
TypedValue
# A single strongly-typed value.
-
value
# The typed value field.
-
bool_value
# A Boolean value:
true
orfalse
.
-
int64_value
# A 64-bit integer. Its range is approximately ±9.2x1018.
-
double_value
# A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision.
-
string_value
# A variable-length string value.
-
distribution_value
# A distribution value.
-
bool_value
Field google.monitoring.v3.TypedValue.bool_value
-
distribution_value
Field google.monitoring.v3.TypedValue.distribution_value
-
double_value
Field google.monitoring.v3.TypedValue.double_value
-
int64_value
Field google.monitoring.v3.TypedValue.int64_value
-
string_value
Field google.monitoring.v3.TypedValue.string_value
-
-
class
google.cloud.monitoring_v3.types.
UpdateAlertPolicyRequest
# The protocol for the
UpdateAlertPolicy
request.-
update_mask
# Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (
alert_policy
), or to the field’s default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value. Examples of valid field masks includedisplay_name
,documentation
,documentation.content
,documentation.mime_type
,user_labels
,user_label.nameofkey
,enabled
,conditions
,combiner
, etc. If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: - The new policy will have the same[ALERT_POLICY_ID]
as the former policy. This gives you continuity with the former policy in your notifications and incidents. - Conditions in the new policy will keep their former[CONDITION_ID]
if the supplied condition includes thename
field with that[CONDITION_ID]
. If the supplied condition omits thename
field, then a new[CONDITION_ID]
is created.
-
alert_policy
# Required. The updated alerting policy or the updated values for the fields listed in
update_mask
. Ifupdate_mask
is not empty, any fields in this policy that are not inupdate_mask
are ignored.
-
alert_policy
Field google.monitoring.v3.UpdateAlertPolicyRequest.alert_policy
-
update_mask
Field google.monitoring.v3.UpdateAlertPolicyRequest.update_mask
-
-
class
google.cloud.monitoring_v3.types.
UpdateGroupRequest
# The
UpdateGroup
request.-
group
# The new definition of the group. All fields of the existing group, excepting
name
, are replaced with the corresponding fields of this group.
-
validate_only
# If true, validate this request but do not update the existing group.
-
group
Field google.monitoring.v3.UpdateGroupRequest.group
-
validate_only
Field google.monitoring.v3.UpdateGroupRequest.validate_only
-
-
class
google.cloud.monitoring_v3.types.
UpdateNotificationChannelRequest
# The
UpdateNotificationChannel
request.-
update_mask
# The fields to update.
-
notification_channel
# A description of the changes to be applied to the specified notification channel. The description must provide a definition for fields to be updated; the names of these fields should also be included in the
update_mask
.
-
notification_channel
Field google.monitoring.v3.UpdateNotificationChannelRequest.notification_channel
-
update_mask
Field google.monitoring.v3.UpdateNotificationChannelRequest.update_mask
-
-
class
google.cloud.monitoring_v3.types.
UpdateUptimeCheckConfigRequest
# The protocol for the
UpdateUptimeCheckConfig
request.-
update_mask
# Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.
-
uptime_check_config
# Required. If an
"updateMask"
has been specified, this field gives the values for the set of fields mentioned in the"updateMask"
. If an"updateMask"
has not been given, this uptime check configuration replaces the current configuration. If a field is mentioned in"updateMask"
but the corresonding field is omitted in this partial uptime check configuration, it has the effect of deleting/clearing the field from the configuration on the server. The following fields can be updated:display_name
,http_check
,tcp_check
,timeout
,content_matchers
, andselected_regions
.
-
update_mask
Field google.monitoring.v3.UpdateUptimeCheckConfigRequest.update_mask
-
uptime_check_config
Field google.monitoring.v3.UpdateUptimeCheckConfigRequest.uptime_check_config
-
-
class
google.cloud.monitoring_v3.types.
UptimeCheckConfig
# This message configures which resources and services to monitor for availability.
-
name
# A unique resource name for this UptimeCheckConfig. The format is:
projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ ID]
. This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.
-
display_name
# A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.
-
resource
# The resource the check is checking. Required.
-
monitored_resource
# The monitored resource associated with the configuration. The following monitored resource types are supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer
-
resource_group
# The group resource associated with the configuration.
-
check_request_type
# The type of uptime check request.
-
http_check
# Contains information needed to make an HTTP or HTTPS check.
-
tcp_check
# Contains information needed to make a TCP check.
-
period
# How often, in seconds, the uptime check is performed. Currently, the only supported values are
60s
(1 minute),300s
(5 minutes),600s
(10 minutes), and900s
(15 minutes). Optional, defaults to300s
.
-
timeout
# The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.
-
content_matchers
# The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response’s content. This field is optional and should only be specified if a content match is required.
-
selected_regions
# The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
-
is_internal
# If this is true, then checks are made only from the ‘internal_checkers’. If it is false, then checks are made only from the ‘selected_regions’. It is an error to provide ‘selected_regions’ when is_internal is true, or to provide ‘internal_checkers’ when is_internal is false.
-
internal_checkers
# The internal checkers that this check will egress from. If
is_internal
is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this CheckConfig.
-
class
ContentMatcher
# Used to perform string matching. It allows substring and regular expressions, together with their negations.
-
content
# String or regex content to match (max 1024 bytes)
-
content
Field google.monitoring.v3.UptimeCheckConfig.ContentMatcher.content
-
-
class
HttpCheck
# Information involved in an HTTP/HTTPS uptime check request.
-
use_ssl
# If true, use HTTPS instead of HTTP to run the check.
-
path
# The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to “/”).
-
port
# The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).
-
auth_info
# The authentication information. Optional when creating an HTTP check; defaults to empty.
-
mask_headers
# Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
-
headers
# The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
-
class
BasicAuthentication
# A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.
-
username
# The username to authenticate.
-
password
# The password to authenticate.
-
password
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication.password
-
username
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication.username
-
-
class
HeadersEntry
# -
key
# Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.HeadersEntry.key
-
value
# Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.HeadersEntry.value
-
-
auth_info
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.auth_info
-
headers
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.headers
-
mask_headers
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.mask_headers
-
path
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.path
-
port
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.port
-
use_ssl
Field google.monitoring.v3.UptimeCheckConfig.HttpCheck.use_ssl
-
-
class
ResourceGroup
# The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.
-
group_id
# The group of resources being monitored. Should be only the group_id, not projects//groups/.
-
resource_type
# The resource type of the group members.
-
group_id
Field google.monitoring.v3.UptimeCheckConfig.ResourceGroup.group_id
-
resource_type
Field google.monitoring.v3.UptimeCheckConfig.ResourceGroup.resource_type
-
-
class
TcpCheck
# Information required for a TCP uptime check request.
-
port
# The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required.
-
port
Field google.monitoring.v3.UptimeCheckConfig.TcpCheck.port
-
-
content_matchers
Field google.monitoring.v3.UptimeCheckConfig.content_matchers
-
display_name
Field google.monitoring.v3.UptimeCheckConfig.display_name
-
http_check
Field google.monitoring.v3.UptimeCheckConfig.http_check
-
internal_checkers
Field google.monitoring.v3.UptimeCheckConfig.internal_checkers
-
is_internal
Field google.monitoring.v3.UptimeCheckConfig.is_internal
-
monitored_resource
Field google.monitoring.v3.UptimeCheckConfig.monitored_resource
-
name
Field google.monitoring.v3.UptimeCheckConfig.name
-
period
Field google.monitoring.v3.UptimeCheckConfig.period
-
resource_group
Field google.monitoring.v3.UptimeCheckConfig.resource_group
-
selected_regions
Field google.monitoring.v3.UptimeCheckConfig.selected_regions
-
tcp_check
Field google.monitoring.v3.UptimeCheckConfig.tcp_check
-
timeout
Field google.monitoring.v3.UptimeCheckConfig.timeout
-
-
class
google.cloud.monitoring_v3.types.
UptimeCheckIp
# Contains the region, location, and list of IP addresses where checkers in the location run from.
-
region
# A broad region category in which the IP address is located.
-
location
# A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region category.
-
ip_address
# The IP address from which the uptime check originates. This is a full IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format; however, one should not rely on the IP addresses being in IPv4 format indefinitely and should support interpreting this field in either IPv4 or IPv6 format.
-
ip_address
Field google.monitoring.v3.UptimeCheckIp.ip_address
-
location
Field google.monitoring.v3.UptimeCheckIp.location
-
region
Field google.monitoring.v3.UptimeCheckIp.region
-
-
class
google.cloud.monitoring_v3.types.
Value
# -
bool_value
# Field google.protobuf.Value.bool_value
-
list_value
# Field google.protobuf.Value.list_value
-
null_value
# Field google.protobuf.Value.null_value
-
number_value
# Field google.protobuf.Value.number_value
-
string_value
# Field google.protobuf.Value.string_value
-
struct_value
# Field google.protobuf.Value.struct_value
-
-
class
google.cloud.monitoring_v3.types.
VerifyNotificationChannelRequest
# The
VerifyNotificationChannel
request.-
name
# The notification channel to verify.
-
code
# The verification code that was delivered to the channel as a result of invoking the
SendNotificationChannelVerificationCode
API method or that was retrieved from a verified channel viaGetNotificationChannelVerificationCode
. For example, one might have “G-123456” or “TKNZGhhd2EyN3I1MnRnMjRv” (in general, one is only guaranteed that the code is valid UTF-8; one should not make any assumptions regarding the structure or format of the code).
-
code
Field google.monitoring.v3.VerifyNotificationChannelRequest.code
-
name
Field google.monitoring.v3.VerifyNotificationChannelRequest.name
-