clouderrorreporting

package
v0.48.1-0...-67a0a95 Latest Latest
Warning

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

 Go to latest Published: Jun 22, 2021 License: BSD-3-Clause Imports: 15 Imported by: 0

Documentation

Overview

Package clouderrorreporting provides access to the Error Reporting API.

For product documentation, see: https://cloud.google.com/error-reporting/

Creating a client

Usage example: 

import "google.golang.org/api/clouderrorreporting/v1beta1"
...
ctx := context.Background()
clouderrorreportingService, err := clouderrorreporting.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication.

For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey: 

clouderrorreportingService, err := clouderrorreporting.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource: 

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
clouderrorreportingService, err := clouderrorreporting.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See https://godoc.org/google.golang.org/api/option/ for details on options.

Index

Constants

View Source 
const (
	// See, edit, configure, and delete your Google Cloud Platform data
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type DeleteEventsResponse 

type DeleteEventsResponse struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

DeleteEventsResponse: Response message for deleting error events.

type ErrorContext 

type ErrorContext struct {
	// HttpRequest: The HTTP request which was processed when the error was
	// triggered.
	HttpRequest *HttpRequestContext `json:"httpRequest,omitempty"`

	// ReportLocation: The location in the source code where the decision
	// was made to report the error, usually the place where it was logged.
	// For a logged exception this would be the source line where the
	// exception is logged, usually close to the place where it was caught.
	ReportLocation *SourceLocation `json:"reportLocation,omitempty"`

	// SourceReferences: Source code that was used to build the executable
	// which has caused the given error message.
	SourceReferences []*SourceReference `json:"sourceReferences,omitempty"`

	// User: The user who caused or was affected by the crash. This can be a
	// user ID, an email address, or an arbitrary token that uniquely
	// identifies the user. When sending an error report, leave this field
	// empty if the user was not logged in. In this case the Error Reporting
	// system will use other data, such as remote IP address, to distinguish
	// affected users. See `affected_users_count` in `ErrorGroupStats`.
	User string `json:"user,omitempty"`

	// ForceSendFields is a list of field names (e.g. "HttpRequest") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "HttpRequest") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ErrorContext: A description of the context in which an error occurred. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs.

func (*ErrorContext) MarshalJSON 

func (s *ErrorContext) MarshalJSON() ([]byte, error)

type ErrorEvent 

type ErrorEvent struct {
	// Context: Data about the context in which the error occurred.
	Context *ErrorContext `json:"context,omitempty"`

	// EventTime: Time when the event occurred as provided in the error
	// report. If the report did not contain a timestamp, the time the error
	// was received by the Error Reporting system is used.
	EventTime string `json:"eventTime,omitempty"`

	// Message: The stack trace that was reported or logged by the service.
	Message string `json:"message,omitempty"`

	// ServiceContext: The `ServiceContext` for which this error was
	// reported.
	ServiceContext *ServiceContext `json:"serviceContext,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Context") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Context") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ErrorEvent: An error event which is returned by the Error Reporting system.

func (*ErrorEvent) MarshalJSON 

func (s *ErrorEvent) MarshalJSON() ([]byte, error)

type ErrorGroup 

type ErrorGroup struct {
	// GroupId: Group IDs are unique for a given project. If the same kind
	// of error occurs in different service contexts, it will receive the
	// same group ID.
	GroupId string `json:"groupId,omitempty"`

	// Name: The group resource name. Example:
	// projects/my-project-123/groups/CNSgkpnppqKCUw
	Name string `json:"name,omitempty"`

	// ResolutionStatus: Error group's resolution status. An unspecified
	// resolution status will be interpreted as OPEN
	//
	// Possible values:
	//   "RESOLUTION_STATUS_UNSPECIFIED" - Status is unknown. When left
	// unspecified in requests, it is treated like OPEN.
	//   "OPEN" - The error group is not being addressed. This is the
	// default for new groups. It is also used for errors re-occurring after
	// marked RESOLVED.
	//   "ACKNOWLEDGED" - Error Group manually acknowledged, it can have an
	// issue link attached.
	//   "RESOLVED" - Error Group manually resolved, more events for this
	// group are not expected to occur.
	//   "MUTED" - The error group is muted and excluded by default on group
	// stats requests.
	ResolutionStatus string `json:"resolutionStatus,omitempty"`

	// TrackingIssues: Associated tracking issues.
	TrackingIssues []*TrackingIssue `json:"trackingIssues,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "GroupId") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "GroupId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ErrorGroup: Description of a group of similar error events.

func (*ErrorGroup) MarshalJSON 

func (s *ErrorGroup) MarshalJSON() ([]byte, error)

type ErrorGroupStats 

type ErrorGroupStats struct {
	// AffectedServices: Service contexts with a non-zero error count for
	// the given filter criteria. This list can be truncated if multiple
	// services are affected. Refer to `num_affected_services` for the total
	// count.
	AffectedServices []*ServiceContext `json:"affectedServices,omitempty"`

	// AffectedUsersCount: Approximate number of affected users in the given
	// group that match the filter criteria. Users are distinguished by data
	// in the `ErrorContext` of the individual error events, such as their
	// login name or their remote IP address in case of HTTP requests. The
	// number of affected users can be zero even if the number of errors is
	// non-zero if no data was provided from which the affected user could
	// be deduced. Users are counted based on data in the request context
	// that was provided in the error report. If more users are implicitly
	// affected, such as due to a crash of the whole service, this is not
	// reflected here.
	AffectedUsersCount int64 `json:"affectedUsersCount,omitempty,string"`

	// Count: Approximate total number of events in the given group that
	// match the filter criteria.
	Count int64 `json:"count,omitempty,string"`

	// FirstSeenTime: Approximate first occurrence that was ever seen for
	// this group and which matches the given filter criteria, ignoring the
	// time_range that was specified in the request.
	FirstSeenTime string `json:"firstSeenTime,omitempty"`

	// Group: Group data that is independent of the filter criteria.
	Group *ErrorGroup `json:"group,omitempty"`

	// LastSeenTime: Approximate last occurrence that was ever seen for this
	// group and which matches the given filter criteria, ignoring the
	// time_range that was specified in the request.
	LastSeenTime string `json:"lastSeenTime,omitempty"`

	// NumAffectedServices: The total number of services with a non-zero
	// error count for the given filter criteria.
	NumAffectedServices int64 `json:"numAffectedServices,omitempty"`

	// Representative: An arbitrary event that is chosen as representative
	// for the whole group. The representative event is intended to be used
	// as a quick preview for the whole group. Events in the group are
	// usually sufficiently similar to each other such that showing an
	// arbitrary representative provides insight into the characteristics of
	// the group as a whole.
	Representative *ErrorEvent `json:"representative,omitempty"`

	// TimedCounts: Approximate number of occurrences over time. Timed
	// counts returned by ListGroups are guaranteed to be: - Inside the
	// requested time interval - Non-overlapping, and - Ordered by ascending
	// time.
	TimedCounts []*TimedCount `json:"timedCounts,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AffectedServices") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AffectedServices") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ErrorGroupStats: Data extracted for a specific group based on certain filter criteria, such as a given time period and/or service filter.

func (*ErrorGroupStats) MarshalJSON 

func (s *ErrorGroupStats) MarshalJSON() ([]byte, error)

type HttpRequestContext 

type HttpRequestContext struct {
	// Method: The type of HTTP request, such as `GET`, `POST`, etc.
	Method string `json:"method,omitempty"`

	// Referrer: The referrer information that is provided with the request.
	Referrer string `json:"referrer,omitempty"`

	// RemoteIp: The IP address from which the request originated. This can
	// be IPv4, IPv6, or a token which is derived from the IP address,
	// depending on the data that has been provided in the error report.
	RemoteIp string `json:"remoteIp,omitempty"`

	// ResponseStatusCode: The HTTP response status code for the request.
	ResponseStatusCode int64 `json:"responseStatusCode,omitempty"`

	// Url: The URL of the request.
	Url string `json:"url,omitempty"`

	// UserAgent: The user agent information that is provided with the
	// request.
	UserAgent string `json:"userAgent,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Method") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Method") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HttpRequestContext: HTTP request data that is related to a reported error. This data should be provided by the application when reporting an error, unless the error report has been generated automatically from Google App Engine logs.

func (*HttpRequestContext) MarshalJSON 

func (s *HttpRequestContext) MarshalJSON() ([]byte, error)

type ListEventsResponse 

type ListEventsResponse struct {
	// ErrorEvents: The error events which match the given request.
	ErrorEvents []*ErrorEvent `json:"errorEvents,omitempty"`

	// NextPageToken: If non-empty, more results are available. Pass this
	// token, along with the same query parameters as the first request, to
	// view the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TimeRangeBegin: The timestamp specifies the start time to which the
	// request was restricted.
	TimeRangeBegin string `json:"timeRangeBegin,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ErrorEvents") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ErrorEvents") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ListEventsResponse: Contains a set of requested error events.

func (*ListEventsResponse) MarshalJSON 

func (s *ListEventsResponse) MarshalJSON() ([]byte, error)

type ListGroupStatsResponse 

type ListGroupStatsResponse struct {
	// ErrorGroupStats: The error group stats which match the given request.
	ErrorGroupStats []*ErrorGroupStats `json:"errorGroupStats,omitempty"`

	// NextPageToken: If non-empty, more results are available. Pass this
	// token, along with the same query parameters as the first request, to
	// view the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// TimeRangeBegin: The timestamp specifies the start time to which the
	// request was restricted. The start time is set based on the requested
	// time range. It may be adjusted to a later time if a project has
	// exceeded the storage quota and older data has been deleted.
	TimeRangeBegin string `json:"timeRangeBegin,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "ErrorGroupStats") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ErrorGroupStats") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ListGroupStatsResponse: Contains a set of requested error group stats.

func (*ListGroupStatsResponse) MarshalJSON 

func (s *ListGroupStatsResponse) MarshalJSON() ([]byte, error)

type ProjectsDeleteEventsCall 

type ProjectsDeleteEventsCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsDeleteEventsCall) Context 

func (c *ProjectsDeleteEventsCall) Context(ctx context.Context) *ProjectsDeleteEventsCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsDeleteEventsCall) Do 

func (c *ProjectsDeleteEventsCall) Do(opts ...googleapi.CallOption) (*DeleteEventsResponse, error)

Do executes the "clouderrorreporting.projects.deleteEvents" call. Exactly one of *DeleteEventsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DeleteEventsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsDeleteEventsCall) Fields 

func (c *ProjectsDeleteEventsCall) Fields(s ...googleapi.Field) *ProjectsDeleteEventsCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsDeleteEventsCall) Header 

func (c *ProjectsDeleteEventsCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsEventsListCall 

type ProjectsEventsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsEventsListCall) Context 

func (c *ProjectsEventsListCall) Context(ctx context.Context) *ProjectsEventsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsEventsListCall) Do 

func (c *ProjectsEventsListCall) Do(opts ...googleapi.CallOption) (*ListEventsResponse, error)

Do executes the "clouderrorreporting.projects.events.list" call. Exactly one of *ListEventsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListEventsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsEventsListCall) Fields 

func (c *ProjectsEventsListCall) Fields(s ...googleapi.Field) *ProjectsEventsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsEventsListCall) GroupId 

func (c *ProjectsEventsListCall) GroupId(groupId string) *ProjectsEventsListCall

GroupId sets the optional parameter "groupId": Required. The group for which events shall be returned.

func (*ProjectsEventsListCall) Header 

func (c *ProjectsEventsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsEventsListCall) IfNoneMatch 

func (c *ProjectsEventsListCall) IfNoneMatch(entityTag string) *ProjectsEventsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsEventsListCall) PageSize 

func (c *ProjectsEventsListCall) PageSize(pageSize int64) *ProjectsEventsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return per response.

func (*ProjectsEventsListCall) PageToken 

func (c *ProjectsEventsListCall) PageToken(pageToken string) *ProjectsEventsListCall

PageToken sets the optional parameter "pageToken": A `next_page_token` provided by a previous response.

func (*ProjectsEventsListCall) Pages 

func (c *ProjectsEventsListCall) Pages(ctx context.Context, f func(*ListEventsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsEventsListCall) ServiceFilterResourceType 

func (c *ProjectsEventsListCall) ServiceFilterResourceType(serviceFilterResourceType string) *ProjectsEventsListCall

ServiceFilterResourceType sets the optional parameter "serviceFilter.resourceType": The exact value to match against `ServiceContext.resource_type` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resourc e_type).

func (*ProjectsEventsListCall) ServiceFilterService 

func (c *ProjectsEventsListCall) ServiceFilterService(serviceFilterService string) *ProjectsEventsListCall

ServiceFilterService sets the optional parameter "serviceFilter.service": The exact value to match against `ServiceContext.service` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service ).

func (*ProjectsEventsListCall) ServiceFilterVersion 

func (c *ProjectsEventsListCall) ServiceFilterVersion(serviceFilterVersion string) *ProjectsEventsListCall

ServiceFilterVersion sets the optional parameter "serviceFilter.version": The exact value to match against `ServiceContext.version` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version ).

func (*ProjectsEventsListCall) TimeRangePeriod 

func (c *ProjectsEventsListCall) TimeRangePeriod(timeRangePeriod string) *ProjectsEventsListCall

TimeRangePeriod sets the optional parameter "timeRange.period": Restricts the query to the specified time range.

Possible values: 

"PERIOD_UNSPECIFIED" - Do not use.
"PERIOD_1_HOUR" - Retrieve data for the last hour. Recommended

minimum timed count duration: 1 min. 

"PERIOD_6_HOURS" - Retrieve data for the last 6 hours. Recommended

minimum timed count duration: 10 min. 

"PERIOD_1_DAY" - Retrieve data for the last day. Recommended

minimum timed count duration: 1 hour. 

"PERIOD_1_WEEK" - Retrieve data for the last week. Recommended

minimum timed count duration: 6 hours. 

"PERIOD_30_DAYS" - Retrieve data for the last 30 days. Recommended

minimum timed count duration: 1 day.

type ProjectsEventsReportCall 

type ProjectsEventsReportCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsEventsReportCall) Context 

func (c *ProjectsEventsReportCall) Context(ctx context.Context) *ProjectsEventsReportCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsEventsReportCall) Do 

func (c *ProjectsEventsReportCall) Do(opts ...googleapi.CallOption) (*ReportErrorEventResponse, error)

Do executes the "clouderrorreporting.projects.events.report" call. Exactly one of *ReportErrorEventResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ReportErrorEventResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsEventsReportCall) Fields 

func (c *ProjectsEventsReportCall) Fields(s ...googleapi.Field) *ProjectsEventsReportCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsEventsReportCall) Header 

func (c *ProjectsEventsReportCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsEventsService 

type ProjectsEventsService struct {
	// contains filtered or unexported fields
}

func NewProjectsEventsService 

func NewProjectsEventsService(s *Service) *ProjectsEventsService

func (*ProjectsEventsService) List 

func (r *ProjectsEventsService) List(projectName string) *ProjectsEventsListCall

List: Lists the specified events.

  • projectName: The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the Google Cloud Platform project ID (https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.

func (*ProjectsEventsService) Report 

func (r *ProjectsEventsService) Report(projectName string, reportederrorevent *ReportedErrorEvent) *ProjectsEventsReportCall

Report: Report an individual error event and record the event to a log. This endpoint accepts **either** an OAuth token, **or** an API key (https://support.google.com/cloud/answer/6158862) for authentication. To use an API key, append it to the URL as the value of a `key` parameter. For example: `POST https://clouderrorreporting.googleapis.com/v1beta1/{projectName}/events:report?key=123ABC456` **Note:** [Error Reporting] (https://cloud.google.com/error-reporting) is a global service built on Cloud Logging and doesn't analyze logs stored in regional log buckets or logs routed to other Google Cloud projects. For more information, see [Using Error Reporting with regionalized logs] (https://cloud.google.com/error-reporting/docs/regionalization).

  • projectName: The resource name of the Google Cloud Platform project. Written as `projects/{projectId}`, where `{projectId}` is the Google Cloud Platform project ID (https://support.google.com/cloud/answer/6158840). Example: // `projects/my-project-123`.

type ProjectsGroupStatsListCall 

type ProjectsGroupStatsListCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGroupStatsListCall) Alignment 

func (c *ProjectsGroupStatsListCall) Alignment(alignment string) *ProjectsGroupStatsListCall

Alignment sets the optional parameter "alignment": The alignment of the timed counts to be returned. Default is `ALIGNMENT_EQUAL_AT_END`.

Possible values: 

"ERROR_COUNT_ALIGNMENT_UNSPECIFIED" - No alignment specified.
"ALIGNMENT_EQUAL_ROUNDED" - The time periods shall be consecutive,

have width equal to the requested duration, and be aligned at the `alignment_time` provided in the request. The `alignment_time` does not have to be inside the query period but even if it is outside, only time periods are returned which overlap with the query period. A rounded alignment will typically result in a different size of the first or the last time period. 

"ALIGNMENT_EQUAL_AT_END" - The time periods shall be consecutive,

have width equal to the requested duration, and be aligned at the end of the requested time period. This can result in a different size of the first time period.

func (*ProjectsGroupStatsListCall) AlignmentTime 

func (c *ProjectsGroupStatsListCall) AlignmentTime(alignmentTime string) *ProjectsGroupStatsListCall

AlignmentTime sets the optional parameter "alignmentTime": Time where the timed counts shall be aligned if rounded alignment is chosen. Default is 00:00 UTC.

func (*ProjectsGroupStatsListCall) Context 

func (c *ProjectsGroupStatsListCall) Context(ctx context.Context) *ProjectsGroupStatsListCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGroupStatsListCall) Do 

func (c *ProjectsGroupStatsListCall) Do(opts ...googleapi.CallOption) (*ListGroupStatsResponse, error)

Do executes the "clouderrorreporting.projects.groupStats.list" call. Exactly one of *ListGroupStatsResponse or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ListGroupStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupStatsListCall) Fields 

func (c *ProjectsGroupStatsListCall) Fields(s ...googleapi.Field) *ProjectsGroupStatsListCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGroupStatsListCall) GroupId 

func (c *ProjectsGroupStatsListCall) GroupId(groupId ...string) *ProjectsGroupStatsListCall

GroupId sets the optional parameter "groupId": List all ErrorGroupStats with these IDs.

func (*ProjectsGroupStatsListCall) Header 

func (c *ProjectsGroupStatsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsGroupStatsListCall) IfNoneMatch 

func (c *ProjectsGroupStatsListCall) IfNoneMatch(entityTag string) *ProjectsGroupStatsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*ProjectsGroupStatsListCall) Order 

func (c *ProjectsGroupStatsListCall) Order(order string) *ProjectsGroupStatsListCall

Order sets the optional parameter "order": The sort order in which the results are returned. Default is `COUNT_DESC`.

Possible values: 

"GROUP_ORDER_UNSPECIFIED" - No group order specified.
"COUNT_DESC" - Total count of errors in the given time window in

descending order. 

"LAST_SEEN_DESC" - Timestamp when the group was last seen in the

given time window in descending order. 

"CREATED_DESC" - Timestamp when the group was created in descending

order. 

"AFFECTED_USERS_DESC" - Number of affected users in the given time

window in descending order.

func (*ProjectsGroupStatsListCall) PageSize 

func (c *ProjectsGroupStatsListCall) PageSize(pageSize int64) *ProjectsGroupStatsListCall

PageSize sets the optional parameter "pageSize": The maximum number of results to return per response. Default is 20.

func (*ProjectsGroupStatsListCall) PageToken 

func (c *ProjectsGroupStatsListCall) PageToken(pageToken string) *ProjectsGroupStatsListCall

PageToken sets the optional parameter "pageToken": A `next_page_token` provided by a previous response. To view additional results, pass this token along with the identical query parameters as the first request.

func (*ProjectsGroupStatsListCall) Pages 

func (c *ProjectsGroupStatsListCall) Pages(ctx context.Context, f func(*ListGroupStatsResponse) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

func (*ProjectsGroupStatsListCall) ServiceFilterResourceType 

func (c *ProjectsGroupStatsListCall) ServiceFilterResourceType(serviceFilterResourceType string) *ProjectsGroupStatsListCall

ServiceFilterResourceType sets the optional parameter "serviceFilter.resourceType": The exact value to match against `ServiceContext.resource_type` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resourc e_type).

func (*ProjectsGroupStatsListCall) ServiceFilterService 

func (c *ProjectsGroupStatsListCall) ServiceFilterService(serviceFilterService string) *ProjectsGroupStatsListCall

ServiceFilterService sets the optional parameter "serviceFilter.service": The exact value to match against `ServiceContext.service` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service ).

func (*ProjectsGroupStatsListCall) ServiceFilterVersion 

func (c *ProjectsGroupStatsListCall) ServiceFilterVersion(serviceFilterVersion string) *ProjectsGroupStatsListCall

ServiceFilterVersion sets the optional parameter "serviceFilter.version": The exact value to match against `ServiceContext.version` (/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version ).

func (*ProjectsGroupStatsListCall) TimeRangePeriod 

func (c *ProjectsGroupStatsListCall) TimeRangePeriod(timeRangePeriod string) *ProjectsGroupStatsListCall

TimeRangePeriod sets the optional parameter "timeRange.period": Restricts the query to the specified time range.

Possible values: 

"PERIOD_UNSPECIFIED" - Do not use.
"PERIOD_1_HOUR" - Retrieve data for the last hour. Recommended

minimum timed count duration: 1 min. 

"PERIOD_6_HOURS" - Retrieve data for the last 6 hours. Recommended

minimum timed count duration: 10 min. 

"PERIOD_1_DAY" - Retrieve data for the last day. Recommended

minimum timed count duration: 1 hour. 

"PERIOD_1_WEEK" - Retrieve data for the last week. Recommended

minimum timed count duration: 6 hours. 

"PERIOD_30_DAYS" - Retrieve data for the last 30 days. Recommended

minimum timed count duration: 1 day.

func (*ProjectsGroupStatsListCall) TimedCountDuration 

func (c *ProjectsGroupStatsListCall) TimedCountDuration(timedCountDuration string) *ProjectsGroupStatsListCall

TimedCountDuration sets the optional parameter "timedCountDuration": The preferred duration for a single returned `TimedCount`. If not set, no timed counts are returned.

type ProjectsGroupStatsService 

type ProjectsGroupStatsService struct {
	// contains filtered or unexported fields
}

func NewProjectsGroupStatsService 

func NewProjectsGroupStatsService(s *Service) *ProjectsGroupStatsService

func (*ProjectsGroupStatsService) List 

func (r *ProjectsGroupStatsService) List(projectName string) *ProjectsGroupStatsListCall

List: Lists the specified groups.

  • projectName: The resource name of the Google Cloud Platform project. Written as `projects/{projectID}` or `projects/{projectNumber}`, where `{projectID}` and `{projectNumber}` can be found in the Google Cloud Console (https://support.google.com/cloud/answer/6158840). Examples: `projects/my-project-123`, `projects/5551234`.

type ProjectsGroupsGetCall 

type ProjectsGroupsGetCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGroupsGetCall) Context 

func (c *ProjectsGroupsGetCall) Context(ctx context.Context) *ProjectsGroupsGetCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGroupsGetCall) Do 

func (c *ProjectsGroupsGetCall) Do(opts ...googleapi.CallOption) (*ErrorGroup, error)

Do executes the "clouderrorreporting.projects.groups.get" call. Exactly one of *ErrorGroup or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ErrorGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsGetCall) Fields 

func (c *ProjectsGroupsGetCall) Fields(s ...googleapi.Field) *ProjectsGroupsGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGroupsGetCall) Header 

func (c *ProjectsGroupsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*ProjectsGroupsGetCall) IfNoneMatch 

func (c *ProjectsGroupsGetCall) IfNoneMatch(entityTag string) *ProjectsGroupsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type ProjectsGroupsService 

type ProjectsGroupsService struct {
	// contains filtered or unexported fields
}

func NewProjectsGroupsService 

func NewProjectsGroupsService(s *Service) *ProjectsGroupsService

func (*ProjectsGroupsService) Get 

func (r *ProjectsGroupsService) Get(groupName string) *ProjectsGroupsGetCall

Get: Get the specified group.

func (*ProjectsGroupsService) Update 

func (r *ProjectsGroupsService) Update(name string, errorgroup *ErrorGroup) *ProjectsGroupsUpdateCall

Update: Replace the data for the specified group. Fails if the group does not exist.

  • name: The group resource name. Example: projects/my-project-123/groups/CNSgkpnppqKCUw.

type ProjectsGroupsUpdateCall 

type ProjectsGroupsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*ProjectsGroupsUpdateCall) Context 

func (c *ProjectsGroupsUpdateCall) Context(ctx context.Context) *ProjectsGroupsUpdateCall

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*ProjectsGroupsUpdateCall) Do 

func (c *ProjectsGroupsUpdateCall) Do(opts ...googleapi.CallOption) (*ErrorGroup, error)

Do executes the "clouderrorreporting.projects.groups.update" call. Exactly one of *ErrorGroup or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *ErrorGroup.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*ProjectsGroupsUpdateCall) Fields 

func (c *ProjectsGroupsUpdateCall) Fields(s ...googleapi.Field) *ProjectsGroupsUpdateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*ProjectsGroupsUpdateCall) Header 

func (c *ProjectsGroupsUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type ProjectsService 

type ProjectsService struct {
	Events *ProjectsEventsService

	GroupStats *ProjectsGroupStatsService

	Groups *ProjectsGroupsService
	// contains filtered or unexported fields
}

func NewProjectsService 

func NewProjectsService(s *Service) *ProjectsService

func (*ProjectsService) DeleteEvents 

func (r *ProjectsService) DeleteEvents(projectName string) *ProjectsDeleteEventsCall

DeleteEvents: Deletes all error events of a given project.

  • projectName: The resource name of the Google Cloud Platform project. Written as `projects/{projectID}`, where `{projectID}` is the Google Cloud Platform project ID (https://support.google.com/cloud/answer/6158840). Example: `projects/my-project-123`.

type ReportErrorEventResponse 

type ReportErrorEventResponse struct {
	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`
}

ReportErrorEventResponse: Response for reporting an individual error event. Data may be added to this message in the future.

type ReportedErrorEvent 

type ReportedErrorEvent struct {
	// Context: Optional. A description of the context in which the error
	// occurred.
	Context *ErrorContext `json:"context,omitempty"`

	// EventTime: Optional. Time when the event occurred. If not provided,
	// the time when the event was received by the Error Reporting system
	// will be used.
	EventTime string `json:"eventTime,omitempty"`

	// Message: Required. The error message. If no `context.reportLocation`
	// is provided, the message must contain a header (typically consisting
	// of the exception type name and an error message) and an exception
	// stack trace in one of the supported programming languages and
	// formats. Supported languages are Java, Python, JavaScript, Ruby, C#,
	// PHP, and Go. Supported stack trace formats are: * **Java**: Must be
	// the return value of `Throwable.printStackTrace()`
	// (https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).
	// * **Python**: Must be the return value of `traceback.format_exc()`
	// (https://docs.python.org/2/library/traceback.html#traceback.format_exc).
	// * **JavaScript**: Must be the value of `error.stack`
	// (https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. *
	// **Ruby**: Must contain frames returned by `Exception.backtrace`
	// (https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).
	// * **C#**: Must be the return value of `Exception.ToString()`
	// (https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).
	// * **PHP**: Must start with `PHP (Notice|Parse error|Fatal
	// error|Warning)` and contain the result of `(string)$exception`
	// (http://php.net/manual/en/exception.tostring.php). * **Go**: Must be
	// the return value of `runtime.Stack()`
	// (https://golang.org/pkg/runtime/debug/#Stack).
	Message string `json:"message,omitempty"`

	// ServiceContext: Required. The service context in which this error has
	// occurred.
	ServiceContext *ServiceContext `json:"serviceContext,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Context") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Context") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ReportedErrorEvent: An error event which is reported to the Error Reporting system.

func (*ReportedErrorEvent) MarshalJSON 

func (s *ReportedErrorEvent) MarshalJSON() ([]byte, error)

type Service 

type Service struct {
	BasePath  string // API endpoint base URL
	UserAgent string // optional additional User-Agent fragment

	Projects *ProjectsService
	// contains filtered or unexported fields
}

func New deprecated 

func New(client *http.Client) (*Service, error)

New creates a new Service. It uses the provided http.Client for requests.

Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.

func NewService 

func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)

NewService creates a new Service.

type ServiceContext 

type ServiceContext struct {
	// ResourceType: Type of the MonitoredResource. List of possible values:
	// https://cloud.google.com/monitoring/api/resources Value is set
	// automatically for incoming errors and must not be set when reporting
	// errors.
	ResourceType string `json:"resourceType,omitempty"`

	// Service: An identifier of the service, such as the name of the
	// executable, job, or Google App Engine service name. This field is
	// expected to have a low number of values that are relatively stable
	// over time, as opposed to `version`, which can be changed whenever new
	// code is deployed. Contains the service name for error reports
	// extracted from Google App Engine logs or `default` if the App Engine
	// default service is used.
	Service string `json:"service,omitempty"`

	// Version: Represents the source code version that the developer
	// provided, which could represent a version label or a Git SHA-1 hash,
	// for example. For App Engine standard environment, the version is set
	// to the version of the app.
	Version string `json:"version,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ResourceType") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ResourceType") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ServiceContext: Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel.

func (*ServiceContext) MarshalJSON 

func (s *ServiceContext) MarshalJSON() ([]byte, error)

type SourceLocation 

type SourceLocation struct {
	// FilePath: The source code filename, which can include a truncated
	// relative path, or a full path from a production machine.
	FilePath string `json:"filePath,omitempty"`

	// FunctionName: Human-readable name of a function or method. The value
	// can include optional context like the class or package name. For
	// example, `my.package.MyClass.method` in case of Java.
	FunctionName string `json:"functionName,omitempty"`

	// LineNumber: 1-based. 0 indicates that the line number is unknown.
	LineNumber int64 `json:"lineNumber,omitempty"`

	// ForceSendFields is a list of field names (e.g. "FilePath") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FilePath") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SourceLocation: Indicates a location in the source code of the service for which errors are reported. `functionName` must be provided by the application when reporting an error, unless the error report contains a `message` with a supported exception stack trace. All fields are optional for the later case.

func (*SourceLocation) MarshalJSON 

func (s *SourceLocation) MarshalJSON() ([]byte, error)

type SourceReference 

type SourceReference struct {
	// Repository: Optional. A URI string identifying the repository.
	// Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"
	Repository string `json:"repository,omitempty"`

	// RevisionId: The canonical and persistent identifier of the deployed
	// revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"
	RevisionId string `json:"revisionId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Repository") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Repository") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

SourceReference: A reference to a particular snapshot of the source tree used to build and deploy an application.

func (*SourceReference) MarshalJSON 

func (s *SourceReference) MarshalJSON() ([]byte, error)

type TimedCount 

type TimedCount struct {
	// Count: Approximate number of occurrences in the given time period.
	Count int64 `json:"count,omitempty,string"`

	// EndTime: End of the time period to which `count` refers (excluded).
	EndTime string `json:"endTime,omitempty"`

	// StartTime: Start of the time period to which `count` refers
	// (included).
	StartTime string `json:"startTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Count") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Count") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TimedCount: The number of errors in a given time period. All numbers are approximate since the error events are sampled before counting them.

func (*TimedCount) MarshalJSON 

func (s *TimedCount) MarshalJSON() ([]byte, error)

type TrackingIssue 

type TrackingIssue struct {
	// Url: A URL pointing to a related entry in an issue tracking system.
	// Example: `https://github.com/user/project/issues/4`
	Url string `json:"url,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Url") to
	// unconditionally include in API requests. By default, fields with
	// empty values are omitted from API requests. However, any non-pointer,
	// non-interface field appearing in ForceSendFields will be sent to the
	// server regardless of whether the field is empty or not. This may be
	// used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Url") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

TrackingIssue: Information related to tracking the progress on resolving the error.

func (*TrackingIssue) MarshalJSON 

func (s *TrackingIssue) MarshalJSON() ([]byte, error)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.