monitoring

package
Version: v0.33.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2018 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package monitoring is an auto-generated package for the Stackdriver Monitoring API.

NOTE: This package is in alpha. It is not stable, and is likely to change.

Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func DefaultAuthScopes

func DefaultAuthScopes() []string

DefaultAuthScopes reports the default set of authentication scopes to use with this package.

func GroupGroupPath deprecated

This function has been deprecated.
func GroupGroupPath(project, group string) string

GroupGroupPath returns the path for the group resource.

Deprecated: Use

fmt.Sprintf("projects/%s/groups/%s", project, group)

instead.

func GroupProjectPath deprecated

This function has been deprecated.
func GroupProjectPath(project string) string

GroupProjectPath returns the path for the project resource.

Deprecated: Use

fmt.Sprintf("projects/%s", project)

instead.

func MetricMetricDescriptorPath deprecated

This function has been deprecated.
func MetricMetricDescriptorPath(project, metricDescriptor string) string

MetricMetricDescriptorPath returns the path for the metric descriptor resource.

Deprecated: Use

fmt.Sprintf("projects/%s/metricDescriptors/%s", project, metricDescriptor)

instead.

func MetricMonitoredResourceDescriptorPath deprecated

This function has been deprecated.
func MetricMonitoredResourceDescriptorPath(project, monitoredResourceDescriptor string) string

MetricMonitoredResourceDescriptorPath returns the path for the monitored resource descriptor resource.

Deprecated: Use

fmt.Sprintf("projects/%s/monitoredResourceDescriptors/%s", project, monitoredResourceDescriptor)

instead.

func MetricProjectPath deprecated

This function has been deprecated.
func MetricProjectPath(project string) string

MetricProjectPath returns the path for the project resource.

Deprecated: Use

fmt.Sprintf("projects/%s", project)

instead.

func UptimeCheckProjectPath deprecated

This function has been deprecated.
func UptimeCheckProjectPath(project string) string

UptimeCheckProjectPath returns the path for the project resource.

Deprecated: Use

fmt.Sprintf("projects/%s", project)

instead.

func UptimeCheckUptimeCheckConfigPath deprecated

This function has been deprecated.
func UptimeCheckUptimeCheckConfigPath(project, uptimeCheckConfig string) string

UptimeCheckUptimeCheckConfigPath returns the path for the uptime check config resource.

Deprecated: Use

fmt.Sprintf("projects/%s/uptimeCheckConfigs/%s", project, uptimeCheckConfig)

instead.

Types

type AlertPolicyCallOptions

type AlertPolicyCallOptions struct {
	ListAlertPolicies []gax.CallOption
	GetAlertPolicy    []gax.CallOption
	CreateAlertPolicy []gax.CallOption
	DeleteAlertPolicy []gax.CallOption
	UpdateAlertPolicy []gax.CallOption
}

AlertPolicyCallOptions contains the retry settings for each method of AlertPolicyClient.

type AlertPolicyClient

type AlertPolicyClient struct {

	// The call options for this service.
	CallOptions *AlertPolicyCallOptions
	// contains filtered or unexported fields
}

AlertPolicyClient is a client for interacting with Stackdriver Monitoring API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewAlertPolicyClient

func NewAlertPolicyClient(ctx context.Context, opts ...option.ClientOption) (*AlertPolicyClient, error)

NewAlertPolicyClient creates a new alert policy service client.

The AlertPolicyService API is used to manage (list, create, delete, edit) alert policies in Stackdriver Monitoring. An alerting policy is 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. In addition to using this API, alert policies can also be managed through Stackdriver Monitoring (at https://cloud.google.com/monitoring/docs/), which can be reached by clicking the "Monitoring" tab in Cloud Console (at https://console.cloud.google.com/).

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*AlertPolicyClient) Close

func (c *AlertPolicyClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*AlertPolicyClient) Connection

func (c *AlertPolicyClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*AlertPolicyClient) CreateAlertPolicy

CreateAlertPolicy creates a new alerting policy.

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateAlertPolicyRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateAlertPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*AlertPolicyClient) DeleteAlertPolicy

func (c *AlertPolicyClient) DeleteAlertPolicy(ctx context.Context, req *monitoringpb.DeleteAlertPolicyRequest, opts ...gax.CallOption) error

DeleteAlertPolicy deletes an alerting policy.

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.DeleteAlertPolicyRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteAlertPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*AlertPolicyClient) GetAlertPolicy

GetAlertPolicy gets a single alerting policy.

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetAlertPolicyRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetAlertPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*AlertPolicyClient) ListAlertPolicies

ListAlertPolicies lists the existing alerting policies for the project.

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListAlertPoliciesRequest{
	// TODO: Fill request struct fields.
}
it := c.ListAlertPolicies(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*AlertPolicyClient) UpdateAlertPolicy

UpdateAlertPolicy 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.

Example
ctx := context.Background()
c, err := monitoring.NewAlertPolicyClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.UpdateAlertPolicyRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.UpdateAlertPolicy(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

type AlertPolicyIterator

type AlertPolicyIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.AlertPolicy, nextPageToken string, err error)
	// contains filtered or unexported fields
}

AlertPolicyIterator manages a stream of *monitoringpb.AlertPolicy.

func (*AlertPolicyIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*AlertPolicyIterator) PageInfo

func (it *AlertPolicyIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type GroupCallOptions

type GroupCallOptions struct {
	ListGroups       []gax.CallOption
	GetGroup         []gax.CallOption
	CreateGroup      []gax.CallOption
	UpdateGroup      []gax.CallOption
	DeleteGroup      []gax.CallOption
	ListGroupMembers []gax.CallOption
}

GroupCallOptions contains the retry settings for each method of GroupClient.

type GroupClient

type GroupClient struct {

	// The call options for this service.
	CallOptions *GroupCallOptions
	// contains filtered or unexported fields
}

GroupClient is a client for interacting with Stackdriver Monitoring API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewGroupClient

func NewGroupClient(ctx context.Context, opts ...option.ClientOption) (*GroupClient, error)

NewGroupClient creates a new group service client.

The Group API lets you inspect and manage your groups (at #google.monitoring.v3.Group).

A group is a named filter that is used to identify a collection of monitored resources. Groups are typically used to mirror the physical and/or logical topology of the environment. Because group membership is computed dynamically, monitored resources that are started in the future are automatically placed in matching groups. By using a group to name monitored resources in, for example, an alert policy, the target of that alert policy is updated automatically as monitored resources are added and removed from the infrastructure.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*GroupClient) Close

func (c *GroupClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*GroupClient) Connection

func (c *GroupClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*GroupClient) CreateGroup

CreateGroup creates a new group.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateGroupRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateGroup(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*GroupClient) DeleteGroup

func (c *GroupClient) DeleteGroup(ctx context.Context, req *monitoringpb.DeleteGroupRequest, opts ...gax.CallOption) error

DeleteGroup deletes an existing group.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.DeleteGroupRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteGroup(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*GroupClient) GetGroup

GetGroup gets a single group.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetGroupRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetGroup(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*GroupClient) ListGroupMembers

ListGroupMembers lists the monitored resources that are members of a group.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListGroupMembersRequest{
	// TODO: Fill request struct fields.
}
it := c.ListGroupMembers(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*GroupClient) ListGroups

ListGroups lists the existing groups.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListGroupsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListGroups(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*GroupClient) UpdateGroup

UpdateGroup updates an existing group. You can change any group attributes except name.

Example
ctx := context.Background()
c, err := monitoring.NewGroupClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.UpdateGroupRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.UpdateGroup(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

type GroupIterator

type GroupIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.Group, nextPageToken string, err error)
	// contains filtered or unexported fields
}

GroupIterator manages a stream of *monitoringpb.Group.

func (*GroupIterator) Next

func (it *GroupIterator) Next() (*monitoringpb.Group, error)

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*GroupIterator) PageInfo

func (it *GroupIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MetricCallOptions

type MetricCallOptions struct {
	ListMonitoredResourceDescriptors []gax.CallOption
	GetMonitoredResourceDescriptor   []gax.CallOption
	ListMetricDescriptors            []gax.CallOption
	GetMetricDescriptor              []gax.CallOption
	CreateMetricDescriptor           []gax.CallOption
	DeleteMetricDescriptor           []gax.CallOption
	ListTimeSeries                   []gax.CallOption
	CreateTimeSeries                 []gax.CallOption
}

MetricCallOptions contains the retry settings for each method of MetricClient.

type MetricClient

type MetricClient struct {

	// The call options for this service.
	CallOptions *MetricCallOptions
	// contains filtered or unexported fields
}

MetricClient is a client for interacting with Stackdriver Monitoring API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewMetricClient

func NewMetricClient(ctx context.Context, opts ...option.ClientOption) (*MetricClient, error)

NewMetricClient creates a new metric service client.

Manages metric descriptors, monitored resource descriptors, and time series data.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*MetricClient) Close

func (c *MetricClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*MetricClient) Connection

func (c *MetricClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*MetricClient) CreateMetricDescriptor

CreateMetricDescriptor creates a new metric descriptor. User-created metric descriptors define custom metrics (at /monitoring/custom-metrics).

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateMetricDescriptorRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateMetricDescriptor(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*MetricClient) CreateTimeSeries

func (c *MetricClient) CreateTimeSeries(ctx context.Context, req *monitoringpb.CreateTimeSeriesRequest, opts ...gax.CallOption) error

CreateTimeSeries 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.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateTimeSeriesRequest{
	// TODO: Fill request struct fields.
}
err = c.CreateTimeSeries(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*MetricClient) DeleteMetricDescriptor

func (c *MetricClient) DeleteMetricDescriptor(ctx context.Context, req *monitoringpb.DeleteMetricDescriptorRequest, opts ...gax.CallOption) error

DeleteMetricDescriptor deletes a metric descriptor. Only user-created custom metrics (at /monitoring/custom-metrics) can be deleted.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.DeleteMetricDescriptorRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteMetricDescriptor(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*MetricClient) GetMetricDescriptor

GetMetricDescriptor gets a single metric descriptor. This method does not require a Stackdriver account.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetMetricDescriptorRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetMetricDescriptor(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*MetricClient) GetMonitoredResourceDescriptor

GetMonitoredResourceDescriptor gets a single monitored resource descriptor. This method does not require a Stackdriver account.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetMonitoredResourceDescriptorRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetMonitoredResourceDescriptor(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*MetricClient) ListMetricDescriptors

ListMetricDescriptors lists metric descriptors that match a filter. This method does not require a Stackdriver account.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListMetricDescriptorsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListMetricDescriptors(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*MetricClient) ListMonitoredResourceDescriptors

ListMonitoredResourceDescriptors lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListMonitoredResourceDescriptorsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListMonitoredResourceDescriptors(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*MetricClient) ListTimeSeries

ListTimeSeries lists time series that match a filter. This method does not require a Stackdriver account.

Example
ctx := context.Background()
c, err := monitoring.NewMetricClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListTimeSeriesRequest{
	// TODO: Fill request struct fields.
}
it := c.ListTimeSeries(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

type MetricDescriptorIterator

type MetricDescriptorIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*metricpb.MetricDescriptor, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MetricDescriptorIterator manages a stream of *metricpb.MetricDescriptor.

func (*MetricDescriptorIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MetricDescriptorIterator) PageInfo

func (it *MetricDescriptorIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MonitoredResourceDescriptorIterator

type MonitoredResourceDescriptorIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoredrespb.MonitoredResourceDescriptor, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MonitoredResourceDescriptorIterator manages a stream of *monitoredrespb.MonitoredResourceDescriptor.

func (*MonitoredResourceDescriptorIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MonitoredResourceDescriptorIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type MonitoredResourceIterator

type MonitoredResourceIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoredrespb.MonitoredResource, nextPageToken string, err error)
	// contains filtered or unexported fields
}

MonitoredResourceIterator manages a stream of *monitoredrespb.MonitoredResource.

func (*MonitoredResourceIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*MonitoredResourceIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type NotificationChannelCallOptions

type NotificationChannelCallOptions struct {
	ListNotificationChannelDescriptors []gax.CallOption
	GetNotificationChannelDescriptor   []gax.CallOption
	ListNotificationChannels           []gax.CallOption
	GetNotificationChannel             []gax.CallOption
	CreateNotificationChannel          []gax.CallOption
	UpdateNotificationChannel          []gax.CallOption
	DeleteNotificationChannel          []gax.CallOption
}

NotificationChannelCallOptions contains the retry settings for each method of NotificationChannelClient.

type NotificationChannelClient

type NotificationChannelClient struct {

	// The call options for this service.
	CallOptions *NotificationChannelCallOptions
	// contains filtered or unexported fields
}

NotificationChannelClient is a client for interacting with Stackdriver Monitoring API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewNotificationChannelClient

func NewNotificationChannelClient(ctx context.Context, opts ...option.ClientOption) (*NotificationChannelClient, error)

NewNotificationChannelClient creates a new notification channel service client.

The Notification Channel API provides access to configuration that controls how messages related to incidents are sent.

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*NotificationChannelClient) Close

func (c *NotificationChannelClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*NotificationChannelClient) Connection

func (c *NotificationChannelClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*NotificationChannelClient) CreateNotificationChannel

CreateNotificationChannel creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or pagerduty service.

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateNotificationChannelRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateNotificationChannel(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*NotificationChannelClient) DeleteNotificationChannel

DeleteNotificationChannel deletes a notification channel.

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.DeleteNotificationChannelRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteNotificationChannel(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*NotificationChannelClient) GetNotificationChannel

GetNotificationChannel 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.

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetNotificationChannelRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetNotificationChannel(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*NotificationChannelClient) GetNotificationChannelDescriptor

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

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetNotificationChannelDescriptorRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetNotificationChannelDescriptor(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*NotificationChannelClient) ListNotificationChannelDescriptors

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

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListNotificationChannelDescriptorsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListNotificationChannelDescriptors(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*NotificationChannelClient) ListNotificationChannels

ListNotificationChannels lists the notification channels that have been created for the project.

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListNotificationChannelsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListNotificationChannels(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*NotificationChannelClient) UpdateNotificationChannel

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

Example
ctx := context.Background()
c, err := monitoring.NewNotificationChannelClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.UpdateNotificationChannelRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.UpdateNotificationChannel(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

type NotificationChannelDescriptorIterator

type NotificationChannelDescriptorIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.NotificationChannelDescriptor, nextPageToken string, err error)
	// contains filtered or unexported fields
}

NotificationChannelDescriptorIterator manages a stream of *monitoringpb.NotificationChannelDescriptor.

func (*NotificationChannelDescriptorIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*NotificationChannelDescriptorIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type NotificationChannelIterator

type NotificationChannelIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.NotificationChannel, nextPageToken string, err error)
	// contains filtered or unexported fields
}

NotificationChannelIterator manages a stream of *monitoringpb.NotificationChannel.

func (*NotificationChannelIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*NotificationChannelIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type TimeSeriesIterator

type TimeSeriesIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.TimeSeries, nextPageToken string, err error)
	// contains filtered or unexported fields
}

TimeSeriesIterator manages a stream of *monitoringpb.TimeSeries.

func (*TimeSeriesIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*TimeSeriesIterator) PageInfo

func (it *TimeSeriesIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type UptimeCheckCallOptions

type UptimeCheckCallOptions struct {
	ListUptimeCheckConfigs  []gax.CallOption
	GetUptimeCheckConfig    []gax.CallOption
	CreateUptimeCheckConfig []gax.CallOption
	UpdateUptimeCheckConfig []gax.CallOption
	DeleteUptimeCheckConfig []gax.CallOption
	ListUptimeCheckIps      []gax.CallOption
}

UptimeCheckCallOptions contains the retry settings for each method of UptimeCheckClient.

type UptimeCheckClient

type UptimeCheckClient struct {

	// The call options for this service.
	CallOptions *UptimeCheckCallOptions
	// contains filtered or unexported fields
}

UptimeCheckClient is a client for interacting with Stackdriver Monitoring API.

Methods, except Close, may be called concurrently. However, fields must not be modified concurrently with method calls.

func NewUptimeCheckClient

func NewUptimeCheckClient(ctx context.Context, opts ...option.ClientOption) (*UptimeCheckClient, error)

NewUptimeCheckClient creates a new uptime check service client.

The UptimeCheckService API is used to manage (list, create, delete, edit) uptime check configurations in the Stackdriver Monitoring product. An uptime check is a piece of configuration that determines which resources and services to monitor for availability. These configurations can also be configured interactively by navigating to the [Cloud Console] (http://console.cloud.google.com), selecting the appropriate project, clicking on "Monitoring" on the left-hand side to navigate to Stackdriver, and then clicking on "Uptime".

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use client.
_ = c
Output:

func (*UptimeCheckClient) Close

func (c *UptimeCheckClient) Close() error

Close closes the connection to the API service. The user should invoke this when the client is no longer required.

func (*UptimeCheckClient) Connection

func (c *UptimeCheckClient) Connection() *grpc.ClientConn

Connection returns the client's connection to the API service.

func (*UptimeCheckClient) CreateUptimeCheckConfig

CreateUptimeCheckConfig creates a new uptime check configuration.

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.CreateUptimeCheckConfigRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.CreateUptimeCheckConfig(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*UptimeCheckClient) DeleteUptimeCheckConfig

func (c *UptimeCheckClient) DeleteUptimeCheckConfig(ctx context.Context, req *monitoringpb.DeleteUptimeCheckConfigRequest, opts ...gax.CallOption) error

DeleteUptimeCheckConfig 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.

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.DeleteUptimeCheckConfigRequest{
	// TODO: Fill request struct fields.
}
err = c.DeleteUptimeCheckConfig(ctx, req)
if err != nil {
	// TODO: Handle error.
}
Output:

func (*UptimeCheckClient) GetUptimeCheckConfig

GetUptimeCheckConfig gets a single uptime check configuration.

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.GetUptimeCheckConfigRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.GetUptimeCheckConfig(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

func (*UptimeCheckClient) ListUptimeCheckConfigs

ListUptimeCheckConfigs lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListUptimeCheckConfigsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListUptimeCheckConfigs(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*UptimeCheckClient) ListUptimeCheckIps

ListUptimeCheckIps returns the list of IPs that checkers run from

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.ListUptimeCheckIpsRequest{
	// TODO: Fill request struct fields.
}
it := c.ListUptimeCheckIps(ctx, req)
for {
	resp, err := it.Next()
	if err == iterator.Done {
		break
	}
	if err != nil {
		// TODO: Handle error.
	}
	// TODO: Use resp.
	_ = resp
}
Output:

func (*UptimeCheckClient) UpdateUptimeCheckConfig

UpdateUptimeCheckConfig 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.

Example
ctx := context.Background()
c, err := monitoring.NewUptimeCheckClient(ctx)
if err != nil {
	// TODO: Handle error.
}

req := &monitoringpb.UpdateUptimeCheckConfigRequest{
	// TODO: Fill request struct fields.
}
resp, err := c.UpdateUptimeCheckConfig(ctx, req)
if err != nil {
	// TODO: Handle error.
}
// TODO: Use resp.
_ = resp
Output:

type UptimeCheckConfigIterator

type UptimeCheckConfigIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.UptimeCheckConfig, nextPageToken string, err error)
	// contains filtered or unexported fields
}

UptimeCheckConfigIterator manages a stream of *monitoringpb.UptimeCheckConfig.

func (*UptimeCheckConfigIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*UptimeCheckConfigIterator) PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

type UptimeCheckIpIterator

type UptimeCheckIpIterator struct {

	// InternalFetch is for use by the Google Cloud Libraries only.
	// It is not part of the stable interface of this package.
	//
	// InternalFetch returns results from a single call to the underlying RPC.
	// The number of results is no greater than pageSize.
	// If there are no more results, nextPageToken is empty and err is nil.
	InternalFetch func(pageSize int, pageToken string) (results []*monitoringpb.UptimeCheckIp, nextPageToken string, err error)
	// contains filtered or unexported fields
}

UptimeCheckIpIterator manages a stream of *monitoringpb.UptimeCheckIp.

func (*UptimeCheckIpIterator) Next

Next returns the next result. Its second return value is iterator.Done if there are no more results. Once Next returns Done, all subsequent calls will return Done.

func (*UptimeCheckIpIterator) PageInfo

func (it *UptimeCheckIpIterator) PageInfo() *iterator.PageInfo

PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto