happygapi.monitoring.projects — happygapi 0.4.8

Cloud Monitoring API: projects. Manages your Cloud Monitoring data and configurations. Most projects must be associated with a Workspace, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Cloud Monitoring documentation (https://cloud.google.com/monitoring/docs). See: https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects

alertPolicies-create$ clj

(alertPolicies-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/alertPolicies/create

Required parameters: name

Optional parameters: none

Body:

{:displayName string, :name string, :documentation {:mimeType string, :content string}, :combiner string, :alertStrategy {:autoClose string, :notificationRateLimit NotificationRateLimit}, :conditions [{:name string, :conditionAbsent MetricAbsence, :conditionMatchedLog LogMatch, :conditionMonitoringQueryLanguage MonitoringQueryLanguageCondition, :conditionThreshold MetricThreshold, :displayName string}], :creationRecord {:mutatedBy string, :mutateTime string}, :mutationRecord {:mutatedBy string, :mutateTime string}, :userLabels {}, :enabled boolean, :validity {:message string, :details [{}], :code integer}, :notificationChannels [string]}

Creates a new alerting policy.

alertPolicies-delete$ clj

(alertPolicies-delete$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/alertPolicies/delete

Required parameters: name

Optional parameters: none

Deletes an alerting policy.

alertPolicies-get$ clj

(alertPolicies-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/alertPolicies/get

Required parameters: name

Optional parameters: none

Gets a single alerting policy.

alertPolicies-list$ clj

(alertPolicies-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/alertPolicies/list

Required parameters: name

Optional parameters: pageSize, filter, pageToken, orderBy

Lists the existing alerting policies for the workspace.

alertPolicies-patch$ clj

(alertPolicies-patch$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/alertPolicies/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:displayName string, :name string, :documentation {:mimeType string, :content string}, :combiner string, :alertStrategy {:autoClose string, :notificationRateLimit NotificationRateLimit}, :conditions [{:name string, :conditionAbsent MetricAbsence, :conditionMatchedLog LogMatch, :conditionMonitoringQueryLanguage MonitoringQueryLanguageCondition, :conditionThreshold MetricThreshold, :displayName string}], :creationRecord {:mutatedBy string, :mutateTime string}, :mutationRecord {:mutatedBy string, :mutateTime string}, :userLabels {}, :enabled boolean, :validity {:message string, :details [{}], :code integer}, :notificationChannels [string]}

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.

collectdTimeSeries-create$ clj

(collectdTimeSeries-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/collectdTimeSeries/create

Required parameters: name

Optional parameters: none

Body:

{:collectdPayloads [{:endTime string, :type string, :metadata {}, :plugin string, :typeInstance string, :startTime string, :pluginInstance string, :values [CollectdValue]}], :collectdVersion string, :resource {:labels {}, :type string}}

Stackdriver Monitoring Agent only: Creates a new time series.This method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.

groups-create$ clj

(groups-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/create

Required parameters: name

Optional parameters: validateOnly

Body:

{:parentName string, :displayName string, :name string, :isCluster boolean, :filter string}

Creates a new group.

groups-delete$ clj

(groups-delete$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/delete

Required parameters: name

Optional parameters: recursive

Deletes an existing group.

groups-get$ clj

(groups-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/get

Required parameters: name

Optional parameters: none

Gets a single group.

groups-list$ clj

(groups-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/list

Required parameters: name

Optional parameters: ancestorsOfGroup, childrenOfGroup, pageToken, pageSize, descendantsOfGroup

Lists the existing groups.

groups-members-list$ clj

(groups-members-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/members/list

Required parameters: name

Optional parameters: pageSize, pageToken, filter, interval.startTime, interval.endTime

Lists the monitored resources that are members of a group.

groups-update$ clj

(groups-update$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/groups/update

Required parameters: name

Optional parameters: validateOnly

Body:

{:parentName string, :displayName string, :name string, :isCluster boolean, :filter string}

Updates an existing group. You can change any group attributes except name.

metricDescriptors-create$ clj

(metricDescriptors-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/metricDescriptors/create

Required parameters: name

Optional parameters: none

Body:

{:description string, :labels [{:description string, :key string, :valueType string}], :valueType string, :monitoredResourceTypes [string], :unit string, :displayName string, :name string, :type string, :metricKind string, :launchStage string, :metadata {:ingestDelay string, :launchStage string, :samplePeriod string}}

Creates a new metric descriptor. The creation is executed asynchronously and callers may check the returned operation to track its progress. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).

metricDescriptors-delete$ clj

(metricDescriptors-delete$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/metricDescriptors/delete

Required parameters: name

Optional parameters: none

Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted.

metricDescriptors-get$ clj

(metricDescriptors-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/metricDescriptors/get

Required parameters: name

Optional parameters: none

Gets a single metric descriptor. This method does not require a Workspace.

metricDescriptors-list$ clj

(metricDescriptors-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/metricDescriptors/list

Required parameters: name

Optional parameters: filter, pageSize, pageToken

Lists metric descriptors that match a filter. This method does not require a Workspace.

monitoredResourceDescriptors-get$ clj

(monitoredResourceDescriptors-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/monitoredResourceDescriptors/get

Required parameters: name

Optional parameters: none

Gets a single monitored resource descriptor. This method does not require a Workspace.

monitoredResourceDescriptors-list$ clj

(monitoredResourceDescriptors-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/monitoredResourceDescriptors/list

Required parameters: name

Optional parameters: filter, pageToken, pageSize

Lists monitored resource descriptors that match a filter. This method does not require a Workspace.

notificationChannelDescriptors-get$ clj

(notificationChannelDescriptors-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannelDescriptors/get

Required parameters: name

Optional parameters: none

Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type.

notificationChannelDescriptors-list$ clj

(notificationChannelDescriptors-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannelDescriptors/list

Required parameters: name

Optional parameters: pageSize, pageToken

Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added.

notificationChannels-create$ clj

(notificationChannels-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/create

Required parameters: name

Optional parameters: none

Body:

{:description string, :labels {}, :displayName string, :name string, :type string, :mutationRecords [{:mutatedBy string, :mutateTime string}], :creationRecord {:mutatedBy string, :mutateTime string}, :verificationStatus string, :userLabels {}, :enabled boolean}

Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service.

notificationChannels-delete$ clj

(notificationChannels-delete$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/delete

Required parameters: name

Optional parameters: force

Deletes a notification channel.

notificationChannels-get$ clj

(notificationChannels-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/get

Required parameters: name

Optional parameters: none

Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords, API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.

notificationChannels-getVerificationCode$ clj

(notificationChannels-getVerificationCode$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/getVerificationCode

Required parameters: name

Optional parameters: none

Body:

{:expireTime string}

Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a much longer, websafe base 64 encoded string that has a longer expiration time.

notificationChannels-list$ clj

(notificationChannels-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/list

Required parameters: name

Optional parameters: pageToken, orderBy, pageSize, filter

Lists the notification channels that have been created for the project.

notificationChannels-patch$ clj

(notificationChannels-patch$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:description string, :labels {}, :displayName string, :name string, :type string, :mutationRecords [{:mutatedBy string, :mutateTime string}], :creationRecord {:mutatedBy string, :mutateTime string}, :verificationStatus string, :userLabels {}, :enabled boolean}

Updates a notification channel. Fields not specified in the field mask remain unchanged.

notificationChannels-sendVerificationCode$ clj

(notificationChannels-sendVerificationCode$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/sendVerificationCode

Required parameters: name

Optional parameters: none

Body:

{}

Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel.

notificationChannels-verify$ clj

(notificationChannels-verify$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/notificationChannels/verify

Required parameters: name

Optional parameters: none

Body:

{:code string}

Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode.

timeSeries-create$ clj

(timeSeries-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/timeSeries/create

Required parameters: name

Optional parameters: none

Body:

{:timeSeries [{:valueType string, :unit string, :metricKind string, :resource MonitoredResource, :points [Point], :metadata MonitoredResourceMetadata, :metric Metric}]}

Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.

timeSeries-list$ clj

(timeSeries-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/timeSeries/list

Required parameters: name

Optional parameters: aggregation.perSeriesAligner, interval.startTime, secondaryAggregation.alignmentPeriod, aggregation.alignmentPeriod, secondaryAggregation.groupByFields, pageToken, aggregation.crossSeriesReducer, interval.endTime, filter, pageSize, aggregation.groupByFields, secondaryAggregation.crossSeriesReducer, secondaryAggregation.perSeriesAligner, view, orderBy

Lists time series that match a filter. This method does not require a Workspace.

timeSeries-query$ clj

(timeSeries-query$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/timeSeries/query

Required parameters: name

Optional parameters: none

Body:

{:pageSize integer, :query string, :pageToken string}

Queries time series using Monitoring Query Language. This method does not require a Workspace.

uptimeCheckConfigs-create$ clj

(uptimeCheckConfigs-create$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/uptimeCheckConfigs/create

Required parameters: parent

Optional parameters: none

Body:

{:httpCheck {:path string, :useSsl boolean, :port integer, :headers {}, :authInfo BasicAuthentication, :maskHeaders boolean, :contentType string, :requestMethod string, :body string, :validateSsl boolean}, :displayName string, :name string, :monitoredResource {:labels {}, :type string}, :contentMatchers [{:content string, :matcher string}], :selectedRegions [string], :internalCheckers [{:gcpZone string, :name string, :state string, :network string, :peerProjectId string, :displayName string}], :resourceGroup {:groupId string, :resourceType string}, :tcpCheck {:port integer}, :period string, :timeout string, :isInternal boolean}

Creates a new Uptime check configuration.

uptimeCheckConfigs-delete$ clj

(uptimeCheckConfigs-delete$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/uptimeCheckConfigs/delete

Required parameters: name

Optional parameters: none

Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.

uptimeCheckConfigs-get$ clj

(uptimeCheckConfigs-get$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/uptimeCheckConfigs/get

Required parameters: name

Optional parameters: none

Gets a single Uptime check configuration.

uptimeCheckConfigs-list$ clj

(uptimeCheckConfigs-list$ auth parameters)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/uptimeCheckConfigs/list

Required parameters: parent

Optional parameters: pageToken, pageSize

Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations).

uptimeCheckConfigs-patch$ clj

(uptimeCheckConfigs-patch$ auth parameters body)

https://cloud.google.com/monitoring/api/api/reference/rest/v3/projects/uptimeCheckConfigs/patch

Required parameters: name

Optional parameters: updateMask

Body:

{:httpCheck {:path string, :useSsl boolean, :port integer, :headers {}, :authInfo BasicAuthentication, :maskHeaders boolean, :contentType string, :requestMethod string, :body string, :validateSsl boolean}, :displayName string, :name string, :monitoredResource {:labels {}, :type string}, :contentMatchers [{:content string, :matcher string}], :selectedRegions [string], :internalCheckers [{:gcpZone string, :name string, :state string, :network string, :peerProjectId string, :displayName string}], :resourceGroup {:groupId string, :resourceType string}, :tcpCheck {:port integer}, :period string, :timeout string, :isInternal boolean}

Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via updateMask. Returns the updated configuration.