package logging

Import Path
	cloud.google.com/go/logging/apiv2 (on go.dev)

Dependency Relation
	imports 18 packages, and imported by one package

Involved Source Files

	      config_client.go
	   d➜ doc.go
		Package logging is an auto-generated package for the
		Stackdriver Logging API.

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

		Writes log entries and manages your Logging configuration.

		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 godoc.org/cloud.google.com/go.

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

	      logging_client.go
	      metrics_client.go
	      path_funcs.go
Package-Level Type Names (total 12, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type CallOptions (struct)
		CallOptions contains the retry settings for each method of Client.

		Fields (total 5, all are exported)
			DeleteLog []gax.CallOption
			ListLogEntries []gax.CallOption
			ListLogs []gax.CallOption
			ListMonitoredResourceDescriptors []gax.CallOption
			WriteLogEntries []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultCallOptions() *CallOptions

	 type Client (struct)
		Client is a client for interacting with Stackdriver Logging API.

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

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

			/* 3 unexporteds ... *//* 3 unexporteds: */
			client loggingpb.LoggingServiceV2Client
				The gRPC API client.

			conn *grpc.ClientConn
				The connection to the service.

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

		Methods (total 8, all 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 the client's connection to the API service.

			(*T) DeleteLog(ctx context.Context, req *loggingpb.DeleteLogRequest, opts ...gax.CallOption) error
				DeleteLog deletes all the log entries in a log.
				The log reappears if it receives new entries.
				Log entries written shortly before the delete operation might not be
				deleted.

			(*T) ListLogEntries(ctx context.Context, req *loggingpb.ListLogEntriesRequest, opts ...gax.CallOption) *LogEntryIterator
				ListLogEntries lists log entries.  Use this method to retrieve log entries from
				Logging.  For ways to export log entries, see
				Exporting Logs (at /logging/docs/export).

			(*T) ListLogs(ctx context.Context, req *loggingpb.ListLogsRequest, opts ...gax.CallOption) *StringIterator
				ListLogs lists the logs in projects, organizations, folders, or billing accounts.
				Only logs that have entries are listed.

			(*T) ListMonitoredResourceDescriptors(ctx context.Context, req *loggingpb.ListMonitoredResourceDescriptorsRequest, opts ...gax.CallOption) *MonitoredResourceDescriptorIterator
				ListMonitoredResourceDescriptors lists the descriptors for monitored resource types used by Logging.

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

			(*T) WriteLogEntries(ctx context.Context, req *loggingpb.WriteLogEntriesRequest, opts ...gax.CallOption) (*loggingpb.WriteLogEntriesResponse, error)
				WriteLogEntries writes log entries to Logging. This API method is the
				only way to send log entries to Logging. This method
				is used, directly or indirectly, by the Logging agent
				(fluentd) and all logging libraries configured to use Logging.
				A single request may contain log entries for a maximum of 1000
				different resources (projects, organizations, billing accounts or
				folders)

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

	 type ConfigCallOptions (struct)
		ConfigCallOptions contains the retry settings for each method of ConfigClient.

		Fields (total 10, all are exported)
			CreateExclusion []gax.CallOption
			CreateSink []gax.CallOption
			DeleteExclusion []gax.CallOption
			DeleteSink []gax.CallOption
			GetExclusion []gax.CallOption
			GetSink []gax.CallOption
			ListExclusions []gax.CallOption
			ListSinks []gax.CallOption
			UpdateExclusion []gax.CallOption
			UpdateSink []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultConfigCallOptions() *ConfigCallOptions

	 type ConfigClient (struct)
		ConfigClient is a client for interacting with Stackdriver Logging API.

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

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

			/* 3 unexporteds ... *//* 3 unexporteds: */
			configClient loggingpb.ConfigServiceV2Client
				The gRPC API client.

			conn *grpc.ClientConn
				The connection to the service.

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

		Methods (total 13, all 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 the client's connection to the API service.

			(*T) CreateExclusion(ctx context.Context, req *loggingpb.CreateExclusionRequest, opts ...gax.CallOption) (*loggingpb.LogExclusion, error)
				CreateExclusion creates a new exclusion in a specified parent resource.
				Only log entries belonging to that resource can be excluded.
				You can have up to 10 exclusions in a resource.

			(*T) CreateSink(ctx context.Context, req *loggingpb.CreateSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)
				CreateSink creates a sink that exports specified log entries to a destination.  The
				export of newly-ingested log entries begins immediately, unless the sink's
				writer_identity is not permitted to write to the destination.  A sink can
				export log entries only from the resource owning the sink.

			(*T) DeleteExclusion(ctx context.Context, req *loggingpb.DeleteExclusionRequest, opts ...gax.CallOption) error
				DeleteExclusion deletes an exclusion.

			(*T) DeleteSink(ctx context.Context, req *loggingpb.DeleteSinkRequest, opts ...gax.CallOption) error
				DeleteSink deletes a sink. If the sink has a unique writer_identity, then that
				service account is also deleted.

			(*T) GetExclusion(ctx context.Context, req *loggingpb.GetExclusionRequest, opts ...gax.CallOption) (*loggingpb.LogExclusion, error)
				GetExclusion gets the description of an exclusion.

			(*T) GetSink(ctx context.Context, req *loggingpb.GetSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)
				GetSink gets a sink.

			(*T) ListExclusions(ctx context.Context, req *loggingpb.ListExclusionsRequest, opts ...gax.CallOption) *LogExclusionIterator
				ListExclusions lists all the exclusions in a parent resource.

			(*T) ListSinks(ctx context.Context, req *loggingpb.ListSinksRequest, opts ...gax.CallOption) *LogSinkIterator
				ListSinks lists sinks.

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

			(*T) UpdateExclusion(ctx context.Context, req *loggingpb.UpdateExclusionRequest, opts ...gax.CallOption) (*loggingpb.LogExclusion, error)
				UpdateExclusion changes one or more properties of an existing exclusion.

			(*T) UpdateSink(ctx context.Context, req *loggingpb.UpdateSinkRequest, opts ...gax.CallOption) (*loggingpb.LogSink, error)
				UpdateSink updates a sink.  This method replaces the following fields in the existing
				sink with values from the new sink: destination, and filter.
				The updated sink might also have a new writer_identity; see the
				unique_writer_identity field.

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

	 type LogEntryIterator (struct)
		LogEntryIterator manages a stream of *loggingpb.LogEntry.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*loggingpb.LogEntry, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*loggingpb.LogEntry
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (*loggingpb.LogEntry, 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 (*Client).ListLogEntries(ctx context.Context, req *loggingpb.ListLogEntriesRequest, opts ...gax.CallOption) *LogEntryIterator

	 type LogExclusionIterator (struct)
		LogExclusionIterator manages a stream of *loggingpb.LogExclusion.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*loggingpb.LogExclusion, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*loggingpb.LogExclusion
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (*loggingpb.LogExclusion, 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 (*ConfigClient).ListExclusions(ctx context.Context, req *loggingpb.ListExclusionsRequest, opts ...gax.CallOption) *LogExclusionIterator

	 type LogMetricIterator (struct)
		LogMetricIterator manages a stream of *loggingpb.LogMetric.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*loggingpb.LogMetric, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*loggingpb.LogMetric
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (*loggingpb.LogMetric, 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 (*MetricsClient).ListLogMetrics(ctx context.Context, req *loggingpb.ListLogMetricsRequest, opts ...gax.CallOption) *LogMetricIterator

	 type LogSinkIterator (struct)
		LogSinkIterator manages a stream of *loggingpb.LogSink.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*loggingpb.LogSink, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*loggingpb.LogSink
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (*loggingpb.LogSink, 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 (*ConfigClient).ListSinks(ctx context.Context, req *loggingpb.ListSinksRequest, opts ...gax.CallOption) *LogSinkIterator

	 type MetricsCallOptions (struct)
		MetricsCallOptions contains the retry settings for each method of MetricsClient.

		Fields (total 5, all are exported)
			CreateLogMetric []gax.CallOption
			DeleteLogMetric []gax.CallOption
			GetLogMetric []gax.CallOption
			ListLogMetrics []gax.CallOption
			UpdateLogMetric []gax.CallOption
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func defaultMetricsCallOptions() *MetricsCallOptions

	 type MetricsClient (struct)
		MetricsClient is a client for interacting with Stackdriver Logging API.

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

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

			/* 3 unexporteds ... *//* 3 unexporteds: */
			conn *grpc.ClientConn
				The connection to the service.

			metricsClient loggingpb.MetricsServiceV2Client
				The gRPC API client.

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

		Methods (total 8, all 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 the client's connection to the API service.

			(*T) CreateLogMetric(ctx context.Context, req *loggingpb.CreateLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)
				CreateLogMetric creates a logs-based metric.

			(*T) DeleteLogMetric(ctx context.Context, req *loggingpb.DeleteLogMetricRequest, opts ...gax.CallOption) error
				DeleteLogMetric deletes a logs-based metric.

			(*T) GetLogMetric(ctx context.Context, req *loggingpb.GetLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)
				GetLogMetric gets a logs-based metric.

			(*T) ListLogMetrics(ctx context.Context, req *loggingpb.ListLogMetricsRequest, opts ...gax.CallOption) *LogMetricIterator
				ListLogMetrics lists logs-based metrics.

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

			(*T) UpdateLogMetric(ctx context.Context, req *loggingpb.UpdateLogMetricRequest, opts ...gax.CallOption) (*loggingpb.LogMetric, error)
				UpdateLogMetric creates or updates a logs-based metric.

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

	 type MonitoredResourceDescriptorIterator (struct)
		MonitoredResourceDescriptorIterator manages a stream of *monitoredrespb.MonitoredResourceDescriptor.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []*monitoredrespb.MonitoredResourceDescriptor, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []*monitoredrespb.MonitoredResourceDescriptor
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (*monitoredrespb.MonitoredResourceDescriptor, 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 (*Client).ListMonitoredResourceDescriptors(ctx context.Context, req *loggingpb.ListMonitoredResourceDescriptorsRequest, opts ...gax.CallOption) *MonitoredResourceDescriptorIterator

	 type StringIterator (struct)
		StringIterator manages a stream of string.

		Fields (total 4, in which 1 are exported)
			InternalFetch func(pageSize int, pageToken string) (results []string, 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.

			/* 3 unexporteds ... *//* 3 unexporteds: */
			items []string
			nextFunc func() error
			pageInfo *iterator.PageInfo
		Methods (total 4, in which 2 are exported)
			(*T) Next() (string, 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 (*Client).ListLogs(ctx context.Context, req *loggingpb.ListLogsRequest, opts ...gax.CallOption) *StringIterator


Package-Level Functions (total 19, in which 11 are exported)

	 func ConfigExclusionPath(project, exclusion string) string
		ConfigExclusionPath returns the path for the exclusion resource.

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

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

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

	 func ConfigSinkPath(project, sink string) string
		ConfigSinkPath returns the path for the sink resource.

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

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

	 func LogPath(project, log string) string
		LogPath returns the path for the log resource.

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

	 func MetricsMetricPath(project, metric string) string
		MetricsMetricPath returns the path for the metric resource.

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

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

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

	 func NewClient(ctx context.Context, opts ...option.ClientOption) (*Client, error)
		NewClient creates a new logging service v2 client.

		Service for ingesting and querying logs.

	 func NewConfigClient(ctx context.Context, opts ...option.ClientOption) (*ConfigClient, error)
		NewConfigClient creates a new config service v2 client.

		Service for configuring sinks used to export log entries out of
		Logging.

	 func NewMetricsClient(ctx context.Context, opts ...option.ClientOption) (*MetricsClient, error)
		NewMetricsClient creates a new metrics service v2 client.

		Service for configuring logs-based metrics.

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

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

	/* 8 unexporteds ... *//* 8 unexporteds: */
	 func defaultCallOptions() *CallOptions
	 func defaultClientOptions() []option.ClientOption
	 func defaultConfigCallOptions() *ConfigCallOptions
	 func defaultConfigClientOptions() []option.ClientOption
	 func defaultMetricsCallOptions() *MetricsCallOptions
	 func defaultMetricsClientOptions() []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 Constants (only one, which is unexported)

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

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.