go: cloud.google.com/go/errorreporting/apiv1beta1 Index | Examples | Files

package errorreporting

import "cloud.google.com/go/errorreporting/apiv1beta1"

Package errorreporting is an auto-generated package for the Stackdriver Error Reporting API.

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

Stackdriver Error Reporting groups and counts similar errors from cloud services. The Stackdriver Error Reporting API provides a way to report new errors and read access to error groups and their associated errors.

Use the client at cloud.google.com/go/errorreporting in preference to this.

Index

Examples

Package Files

doc.go error_group_client.go error_stats_client.go report_errors_client.go

func DefaultAuthScopes Uses

func DefaultAuthScopes() []string

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

func ErrorGroupGroupPath Uses

func ErrorGroupGroupPath(project, group string) string

ErrorGroupGroupPath returns the path for the group resource.

func ErrorStatsProjectPath Uses

func ErrorStatsProjectPath(project string) string

ErrorStatsProjectPath returns the path for the project resource.

func ReportErrorsProjectPath Uses

func ReportErrorsProjectPath(project string) string

ReportErrorsProjectPath returns the path for the project resource.

type ErrorEventIterator Uses

type ErrorEventIterator 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 []*clouderrorreportingpb.ErrorEvent, nextPageToken string, err error)
    // contains filtered or unexported fields
}

ErrorEventIterator manages a stream of *clouderrorreportingpb.ErrorEvent.

func (*ErrorEventIterator) Next Uses

func (it *ErrorEventIterator) Next() (*clouderrorreportingpb.ErrorEvent, 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 (*ErrorEventIterator) PageInfo Uses

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

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

type ErrorGroupCallOptions Uses

type ErrorGroupCallOptions struct {
    GetGroup    []gax.CallOption
    UpdateGroup []gax.CallOption
}

ErrorGroupCallOptions contains the retry settings for each method of ErrorGroupClient.

type ErrorGroupClient Uses

type ErrorGroupClient struct {

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

ErrorGroupClient is a client for interacting with Stackdriver Error Reporting API.

func NewErrorGroupClient Uses

func NewErrorGroupClient(ctx context.Context, opts ...option.ClientOption) (*ErrorGroupClient, error)

NewErrorGroupClient creates a new error group service client.

Service for retrieving and updating individual error groups.

Code:

ctx := context.Background()
c, err := errorreporting.NewErrorGroupClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*ErrorGroupClient) Close Uses

func (c *ErrorGroupClient) Close() error

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

func (*ErrorGroupClient) Connection Uses

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

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

func (*ErrorGroupClient) GetGroup Uses

func (c *ErrorGroupClient) GetGroup(ctx context.Context, req *clouderrorreportingpb.GetGroupRequest, opts ...gax.CallOption) (*clouderrorreportingpb.ErrorGroup, error)

GetGroup get the specified group.

Code:

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

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

func (*ErrorGroupClient) SetGoogleClientInfo Uses

func (c *ErrorGroupClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

func (*ErrorGroupClient) UpdateGroup Uses

func (c *ErrorGroupClient) UpdateGroup(ctx context.Context, req *clouderrorreportingpb.UpdateGroupRequest, opts ...gax.CallOption) (*clouderrorreportingpb.ErrorGroup, error)

UpdateGroup replace the data for the specified group. Fails if the group does not exist.

Code:

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

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

type ErrorGroupStatsIterator Uses

type ErrorGroupStatsIterator 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 []*clouderrorreportingpb.ErrorGroupStats, nextPageToken string, err error)
    // contains filtered or unexported fields
}

ErrorGroupStatsIterator manages a stream of *clouderrorreportingpb.ErrorGroupStats.

func (*ErrorGroupStatsIterator) Next Uses

func (it *ErrorGroupStatsIterator) Next() (*clouderrorreportingpb.ErrorGroupStats, 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 (*ErrorGroupStatsIterator) PageInfo Uses

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

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

type ErrorStatsCallOptions Uses

type ErrorStatsCallOptions struct {
    ListGroupStats []gax.CallOption
    ListEvents     []gax.CallOption
    DeleteEvents   []gax.CallOption
}

ErrorStatsCallOptions contains the retry settings for each method of ErrorStatsClient.

type ErrorStatsClient Uses

type ErrorStatsClient struct {

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

ErrorStatsClient is a client for interacting with Stackdriver Error Reporting API.

func NewErrorStatsClient Uses

func NewErrorStatsClient(ctx context.Context, opts ...option.ClientOption) (*ErrorStatsClient, error)

NewErrorStatsClient creates a new error stats service client.

An API for retrieving and managing error statistics as well as data for individual events.

Code:

ctx := context.Background()
c, err := errorreporting.NewErrorStatsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*ErrorStatsClient) Close Uses

func (c *ErrorStatsClient) Close() error

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

func (*ErrorStatsClient) Connection Uses

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

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

func (*ErrorStatsClient) DeleteEvents Uses

func (c *ErrorStatsClient) DeleteEvents(ctx context.Context, req *clouderrorreportingpb.DeleteEventsRequest, opts ...gax.CallOption) (*clouderrorreportingpb.DeleteEventsResponse, error)

DeleteEvents deletes all error events of a given project.

Code:

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

req := &clouderrorreportingpb.DeleteEventsRequest{
// TODO: Fill request struct fields.
}
resp, err := c.DeleteEvents(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*ErrorStatsClient) ListEvents Uses

func (c *ErrorStatsClient) ListEvents(ctx context.Context, req *clouderrorreportingpb.ListEventsRequest, opts ...gax.CallOption) *ErrorEventIterator

ListEvents lists the specified events.

Code:

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

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

func (*ErrorStatsClient) ListGroupStats Uses

func (c *ErrorStatsClient) ListGroupStats(ctx context.Context, req *clouderrorreportingpb.ListGroupStatsRequest, opts ...gax.CallOption) *ErrorGroupStatsIterator

ListGroupStats lists the specified groups.

Code:

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

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

func (*ErrorStatsClient) SetGoogleClientInfo Uses

func (c *ErrorStatsClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

type ReportErrorsCallOptions Uses

type ReportErrorsCallOptions struct {
    ReportErrorEvent []gax.CallOption
}

ReportErrorsCallOptions contains the retry settings for each method of ReportErrorsClient.

type ReportErrorsClient Uses

type ReportErrorsClient struct {

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

ReportErrorsClient is a client for interacting with Stackdriver Error Reporting API.

func NewReportErrorsClient Uses

func NewReportErrorsClient(ctx context.Context, opts ...option.ClientOption) (*ReportErrorsClient, error)

NewReportErrorsClient creates a new report errors service client.

An API for reporting error events.

Code:

ctx := context.Background()
c, err := errorreporting.NewReportErrorsClient(ctx)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use client.
_ = c

func (*ReportErrorsClient) Close Uses

func (c *ReportErrorsClient) Close() error

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

func (*ReportErrorsClient) Connection Uses

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

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

func (*ReportErrorsClient) ReportErrorEvent Uses

func (c *ReportErrorsClient) ReportErrorEvent(ctx context.Context, req *clouderrorreportingpb.ReportErrorEventRequest, opts ...gax.CallOption) (*clouderrorreportingpb.ReportErrorEventResponse, error)

ReportErrorEvent report an individual error event.

This endpoint accepts <strong>either</strong> an OAuth token, <strong>or</strong> an <a href="https://support.google.com/cloud/answer/6158862">API key</a> for authentication. To use an API key, append it to the URL as the value of a key parameter. For example:<pre>POST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456</pre>

Code:

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

req := &clouderrorreportingpb.ReportErrorEventRequest{
// TODO: Fill request struct fields.
}
resp, err := c.ReportErrorEvent(ctx, req)
if err != nil {
    // TODO: Handle error.
}
// TODO: Use resp.
_ = resp

func (*ReportErrorsClient) SetGoogleClientInfo Uses

func (c *ReportErrorsClient) SetGoogleClientInfo(keyval ...string)

SetGoogleClientInfo sets the name and version of the application in the `x-goog-api-client` header passed on each request. Intended for use by Google-written clients.

Package errorreporting imports 12 packages (graph) and is imported by 1 packages. Updated 2017-11-17. Refresh now. Tools for package owners.