package errorreporting

Import Path
	cloud.google.com/go/errorreporting/apiv1beta1 (on go.dev)

Dependency Relation
	imports 19 packages, and imported by one package

Involved Source Files

	   d➜ doc.go
		Package errorreporting is an auto-generated package for the
		Stackdriver Error Reporting API.

		Groups and counts similar errors from cloud services and applications,
		reports new errors, and provides access to error groups and their
		associated errors.

		  NOTE: This package is in beta. It is not stable, and may be subject to changes.

		Use of Context

		The ctx passed to NewClient is used for authentication requests and
		for creating the underlying connection, but is not used for subsequent calls.
		Individual methods on the client use the ctx given to them.

		To close the open connection, use the Close() method.

		For information about setting deadlines, reusing contexts, and more
		please visit pkg.go.dev/cloud.google.com/go.

	      error_group_client.go
	      error_stats_client.go
	      info.go
	      path_funcs.go
	      report_errors_client.go
Package-Level Type Names (total 10, in which 8 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ErrorEventIterator (struct)
		ErrorEventIterator manages a stream of *clouderrorreportingpb.ErrorEvent.

		Fields (total 5, in which 2 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*clouderrorreportingpb.ErrorEvent, nextPageToken string, err error)
				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.

			Response interface{}
				Response is the raw response for the current page.
				It must be cast to the RPC response type.
				Calling Next() or InternalFetch() updates this value.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*clouderrorreportingpb.ErrorEvent
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) 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.

			(*T) PageInfo() *iterator.PageInfo
				PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) bufLen() int
			(*T) takeBuf() interface{}
		Implements (at least one exported)
			*T : google.golang.org/api/iterator.Pageable
		As Outputs Of (at least one exported)
			func (*ErrorStatsClient).ListEvents(ctx context.Context, req *clouderrorreportingpb.ListEventsRequest, opts ...gax.CallOption) *ErrorEventIterator

	 type ErrorGroupCallOptions (struct)
		ErrorGroupCallOptions contains the retry settings for each method of ErrorGroupClient.

		Fields (total 2, both are exported)
			GetGroup []gax.CallOption
			UpdateGroup []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultErrorGroupCallOptions() *ErrorGroupCallOptions

	 type ErrorGroupClient (struct)
		ErrorGroupClient is a client for interacting with Stackdriver Error Reporting API.

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

		Fields (total 5, in which 1 are exported)
			CallOptions *ErrorGroupCallOptions
				The call options for this service.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			connPool gtransport.ConnPool
				Connection pool of gRPC connections to the service.

			disableDeadlines bool
				flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE

			errorGroupClient clouderrorreportingpb.ErrorGroupServiceClient
				The gRPC API client.

			xGoogMetadata metadata.MD
				The x-goog-* metadata to be sent with each request.

		Methods (total 6, in which 5 are exported)
			(*T) Close() error
				Close closes the connection to the API service. The user should invoke this when
				the client is no longer required.

			(*T) Connection() *grpc.ClientConn
				Connection returns a connection to the API service.

				Deprecated.

			(*T) GetGroup(ctx context.Context, req *clouderrorreportingpb.GetGroupRequest, opts ...gax.CallOption) (*clouderrorreportingpb.ErrorGroup, error)
				GetGroup get the specified group.

			(*T) SetGoogleClientInfo(keyval ...string)
				SetGoogleClientInfo sets the name and version of the application in
				the `x-goog-api-client` header passed on each request. Also passes any
				provided key-value pairs. Intended for use by Google-written clients.

				Internal use only.

			(*T) 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.

			/* one unexported ... *//* one unexported: */
			(*T) 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.

		Implements (at least one exported)
			*T : io.Closer
		As Outputs Of (at least one exported)
			func NewErrorGroupClient(ctx context.Context, opts ...option.ClientOption) (*ErrorGroupClient, error)

	 type ErrorGroupStatsIterator (struct)
		ErrorGroupStatsIterator manages a stream of *clouderrorreportingpb.ErrorGroupStats.

		Fields (total 5, in which 2 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*clouderrorreportingpb.ErrorGroupStats, nextPageToken string, err error)
				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.

			Response interface{}
				Response is the raw response for the current page.
				It must be cast to the RPC response type.
				Calling Next() or InternalFetch() updates this value.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*clouderrorreportingpb.ErrorGroupStats
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) 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.

			(*T) PageInfo() *iterator.PageInfo
				PageInfo supports pagination. See the google.golang.org/api/iterator package for details.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) bufLen() int
			(*T) takeBuf() interface{}
		Implements (at least one exported)
			*T : google.golang.org/api/iterator.Pageable
		As Outputs Of (at least one exported)
			func (*ErrorStatsClient).ListGroupStats(ctx context.Context, req *clouderrorreportingpb.ListGroupStatsRequest, opts ...gax.CallOption) *ErrorGroupStatsIterator

	 type ErrorStatsCallOptions (struct)
		ErrorStatsCallOptions contains the retry settings for each method of ErrorStatsClient.

		Fields (total 3, all are exported)
			DeleteEvents []gax.CallOption
			ListEvents []gax.CallOption
			ListGroupStats []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultErrorStatsCallOptions() *ErrorStatsCallOptions

	 type ErrorStatsClient (struct)
		ErrorStatsClient is a client for interacting with Stackdriver Error Reporting API.

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

		Fields (total 5, in which 1 are exported)
			CallOptions *ErrorStatsCallOptions
				The call options for this service.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			connPool gtransport.ConnPool
				Connection pool of gRPC connections to the service.

			disableDeadlines bool
				flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE

			errorStatsClient clouderrorreportingpb.ErrorStatsServiceClient
				The gRPC API client.

			xGoogMetadata metadata.MD
				The x-goog-* metadata to be sent with each request.

		Methods (total 7, in which 6 are exported)
			(*T) Close() error
				Close closes the connection to the API service. The user should invoke this when
				the client is no longer required.

			(*T) Connection() *grpc.ClientConn
				Connection returns a connection to the API service.

				Deprecated.

			(*T) DeleteEvents(ctx context.Context, req *clouderrorreportingpb.DeleteEventsRequest, opts ...gax.CallOption) (*clouderrorreportingpb.DeleteEventsResponse, error)
				DeleteEvents deletes all error events of a given project.

			(*T) ListEvents(ctx context.Context, req *clouderrorreportingpb.ListEventsRequest, opts ...gax.CallOption) *ErrorEventIterator
				ListEvents lists the specified events.

			(*T) ListGroupStats(ctx context.Context, req *clouderrorreportingpb.ListGroupStatsRequest, opts ...gax.CallOption) *ErrorGroupStatsIterator
				ListGroupStats lists the specified groups.

			(*T) SetGoogleClientInfo(keyval ...string)
				SetGoogleClientInfo sets the name and version of the application in
				the `x-goog-api-client` header passed on each request. Also passes any
				provided key-value pairs. Intended for use by Google-written clients.

				Internal use only.

			/* one unexported ... *//* one unexported: */
			(*T) 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.

		Implements (at least one exported)
			*T : io.Closer
		As Outputs Of (at least one exported)
			func NewErrorStatsClient(ctx context.Context, opts ...option.ClientOption) (*ErrorStatsClient, error)

	 type ReportErrorsCallOptions (struct)
		ReportErrorsCallOptions contains the retry settings for each method of ReportErrorsClient.

		Fields (only one, which is exported)
			ReportErrorEvent []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultReportErrorsCallOptions() *ReportErrorsCallOptions

	 type ReportErrorsClient (struct)
		ReportErrorsClient is a client for interacting with Stackdriver Error Reporting API.

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

		Fields (total 5, in which 1 are exported)
			CallOptions *ReportErrorsCallOptions
				The call options for this service.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			connPool gtransport.ConnPool
				Connection pool of gRPC connections to the service.

			disableDeadlines bool
				flag to opt out of default deadlines via GOOGLE_API_GO_EXPERIMENTAL_DISABLE_DEFAULT_DEADLINE

			reportErrorsClient clouderrorreportingpb.ReportErrorsServiceClient
				The gRPC API client.

			xGoogMetadata metadata.MD
				The x-goog-* metadata to be sent with each request.

		Methods (total 5, in which 4 are exported)
			(*T) Close() error
				Close closes the connection to the API service. The user should invoke this when
				the client is no longer required.

			(*T) Connection() *grpc.ClientConn
				Connection returns a connection to the API service.

				Deprecated.

			(*T) ReportErrorEvent(ctx context.Context, req *clouderrorreportingpb.ReportErrorEventRequest, opts ...gax.CallOption) (*clouderrorreportingpb.ReportErrorEventResponse, error)
				ReportErrorEvent report an individual error event.

				This endpoint accepts either an OAuth token,
				or an API key (at 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/projects/example-project/events:report?key=123ABC456

			(*T) SetGoogleClientInfo(keyval ...string)
				SetGoogleClientInfo sets the name and version of the application in
				the `x-goog-api-client` header passed on each request. Also passes any
				provided key-value pairs. Intended for use by Google-written clients.

				Internal use only.

			/* one unexported ... *//* one unexported: */
			(*T) 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.

		Implements (at least 2, in which 1 are exported)
			*T : io.Closer
			/* at least one unexported ... *//* at least one unexported: */
			*T : cloud.google.com/go/errorreporting.client
		As Outputs Of (at least one exported)
			func NewReportErrorsClient(ctx context.Context, opts ...option.ClientOption) (*ReportErrorsClient, error)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type clientHook (func)

		As Types Of (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			  var newErrorGroupClientHook
			  var newErrorStatsClientHook
			  var newReportErrorsClientHook

	 type clientHookParams (struct)
		For more information on implementing a client constructor hook, see
		https://github.com/googleapis/google-cloud-go/wiki/Customizing-constructors.



Package-Level Functions (total 16, in which 7 are exported)

	 func DefaultAuthScopes() []string
		DefaultAuthScopes reports the default set of authentication scopes to use with this package.

	 func ErrorStatsProjectPath(project string) string
		ErrorStatsProjectPath returns the path for the project resource.

		Deprecated: Use
		  fmt.Sprintf("projects/%s", project)
		instead.

	 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.

	 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.

	 func NewReportErrorsClient(ctx context.Context, opts ...option.ClientOption) (*ReportErrorsClient, error)
		NewReportErrorsClient creates a new report errors service client.

		An API for reporting error events.

	 func ReportErrorsProjectPath(project string) string
		ReportErrorsProjectPath returns the path for the project resource.

		Deprecated: Use
		  fmt.Sprintf("projects/%s", project)
		instead.

	 func ResultPath(result string) string
		ResultPath returns the path for the result resource.

		Deprecated: Use
		  fmt.Sprintf("inspect/results/%s", result)
		instead.

	/* 9 unexporteds ... *//* 9 unexporteds: */
	 func checkDisableDeadlines() (bool, error)
	 func defaultErrorGroupCallOptions() *ErrorGroupCallOptions
	 func defaultErrorGroupClientOptions() []option.ClientOption
	 func defaultErrorStatsCallOptions() *ErrorStatsCallOptions
	 func defaultErrorStatsClientOptions() []option.ClientOption
	 func defaultReportErrorsCallOptions() *ReportErrorsCallOptions
	 func defaultReportErrorsClientOptions() []option.ClientOption
	 func insertMetadata(ctx context.Context, mds ...metadata.MD) context.Context
	 func versionGo() string
		versionGo returns the Go runtime version. The returned string
		has no whitespace, suitable for reporting in header.


Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var newErrorGroupClientHook clientHook
	  var newErrorStatsClientHook clientHook
	  var newReportErrorsClientHook clientHook
Package-Level Constants (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	const versionClient = "20200912"

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.