logging library

Classes

BigQueryDatasetResponse
Describes a BigQuery dataset that was created by a link.
BigQueryOptions
Options that change functionality of a sink exporting data to BigQuery.
BigQueryOptionsResponse
Options that change functionality of a sink exporting data to BigQuery.
BillingAccountBucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. Auto-naming is currently not supported for this resource.
BillingAccountBucketArgs
The set of arguments for BillingAccountBucket. The set of arguments for BillingAccountBucket.
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. Auto-naming is currently not supported for this resource.
BillingAccountBucketLinkArgs
The set of arguments for BillingAccountBucketLink. The set of arguments for BillingAccountBucketLink.
BillingAccountBucketView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. Auto-naming is currently not supported for this resource.
BillingAccountBucketViewArgs
The set of arguments for BillingAccountBucketView. The set of arguments for BillingAccountBucketView.
BillingAccountExclusion
Creates a new exclusion in the _Default sink 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.
BillingAccountExclusionArgs
The set of arguments for BillingAccountExclusion. The set of arguments for BillingAccountExclusion.
BillingAccountSink
Creates a sink that exports specified log entries to a destination. The export begins upon ingress, 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.
BillingAccountSinkArgs
The set of arguments for BillingAccountSink. The set of arguments for BillingAccountSink.
Bucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. Auto-naming is currently not supported for this resource.
BucketArgs
The set of arguments for Bucket. The set of arguments for Bucket.
BucketOptions
BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
BucketOptionsResponse
BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.
BucketView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views.
BucketViewArgs
The set of arguments for BucketView. The set of arguments for BucketView.
CmekSettings
Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
CmekSettingsResponse
Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.
Exclusion
Creates a new exclusion in the _Default sink 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.
ExclusionArgs
The set of arguments for Exclusion. The set of arguments for Exclusion.
Explicit
Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
ExplicitResponse
Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.
Exponential
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
ExponentialResponse
Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)).
FolderBucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. Auto-naming is currently not supported for this resource.
FolderBucketArgs
The set of arguments for FolderBucket. The set of arguments for FolderBucket.
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. Auto-naming is currently not supported for this resource.
FolderBucketLinkArgs
The set of arguments for FolderBucketLink. The set of arguments for FolderBucketLink.
FolderBucketView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. Auto-naming is currently not supported for this resource.
FolderBucketViewArgs
The set of arguments for FolderBucketView. The set of arguments for FolderBucketView.
FolderExclusion
Creates a new exclusion in the _Default sink 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.
FolderExclusionArgs
The set of arguments for FolderExclusion. The set of arguments for FolderExclusion.
FolderSink
Creates a sink that exports specified log entries to a destination. The export begins upon ingress, 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.
FolderSinkArgs
The set of arguments for FolderSink. The set of arguments for FolderSink.
GetBillingAccountBucketArgs
Arguments for getBillingAccountBucket. Arguments for getBillingAccountBucket.
GetBillingAccountBucketLinkArgs
Arguments for getBillingAccountBucketLink. Arguments for getBillingAccountBucketLink.
GetBillingAccountBucketLinkResult
Result data returned by getBillingAccountBucketLink.
GetBillingAccountBucketResult
Result data returned by getBillingAccountBucket.
GetBillingAccountBucketViewArgs
Arguments for getBillingAccountBucketView. Arguments for getBillingAccountBucketView.
GetBillingAccountBucketViewResult
Result data returned by getBillingAccountBucketView.
GetBillingAccountExclusionArgs
Arguments for getBillingAccountExclusion. Arguments for getBillingAccountExclusion.
GetBillingAccountExclusionResult
Result data returned by getBillingAccountExclusion.
GetBillingAccountSinkArgs
Arguments for getBillingAccountSink. Arguments for getBillingAccountSink.
GetBillingAccountSinkResult
Result data returned by getBillingAccountSink.
GetBucketArgs
Arguments for getBucket. Arguments for getBucket.
GetBucketResult
Result data returned by getBucket.
GetBucketViewArgs
Arguments for getBucketView. Arguments for getBucketView.
GetBucketViewResult
Result data returned by getBucketView.
GetExclusionArgs
Arguments for getExclusion. Arguments for getExclusion.
GetExclusionResult
Result data returned by getExclusion.
GetFolderBucketArgs
Arguments for getFolderBucket. Arguments for getFolderBucket.
GetFolderBucketLinkArgs
Arguments for getFolderBucketLink. Arguments for getFolderBucketLink.
GetFolderBucketLinkResult
Result data returned by getFolderBucketLink.
GetFolderBucketResult
Result data returned by getFolderBucket.
GetFolderBucketViewArgs
Arguments for getFolderBucketView. Arguments for getFolderBucketView.
GetFolderBucketViewResult
Result data returned by getFolderBucketView.
GetFolderExclusionArgs
Arguments for getFolderExclusion. Arguments for getFolderExclusion.
GetFolderExclusionResult
Result data returned by getFolderExclusion.
GetFolderSinkArgs
Arguments for getFolderSink. Arguments for getFolderSink.
GetFolderSinkResult
Result data returned by getFolderSink.
GetLinkArgs
Arguments for getLink. Arguments for getLink.
GetLinkResult
Result data returned by getLink.
GetMetricArgs
Arguments for getMetric. Arguments for getMetric.
GetMetricResult
Result data returned by getMetric.
GetOrganizationBucketArgs
Arguments for getOrganizationBucket. Arguments for getOrganizationBucket.
GetOrganizationBucketLinkArgs
Arguments for getOrganizationBucketLink. Arguments for getOrganizationBucketLink.
GetOrganizationBucketLinkResult
Result data returned by getOrganizationBucketLink.
GetOrganizationBucketResult
Result data returned by getOrganizationBucket.
GetOrganizationBucketViewArgs
Arguments for getOrganizationBucketView. Arguments for getOrganizationBucketView.
GetOrganizationBucketViewResult
Result data returned by getOrganizationBucketView.
GetOrganizationExclusionArgs
Arguments for getOrganizationExclusion. Arguments for getOrganizationExclusion.
GetOrganizationExclusionResult
Result data returned by getOrganizationExclusion.
GetOrganizationSinkArgs
Arguments for getOrganizationSink. Arguments for getOrganizationSink.
GetOrganizationSinkResult
Result data returned by getOrganizationSink.
GetSinkArgs
Arguments for getSink. Arguments for getSink.
GetSinkResult
Result data returned by getSink.
IndexConfig
Configuration for an indexed field.
IndexConfigResponse
Configuration for an indexed field.
LabelDescriptor
A description of a label.
LabelDescriptorResponse
A description of a label.
Linear
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i).Lower bound (1 <= i < N): offset + (width * (i - 1)).
LinearResponse
Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i).Lower bound (1 <= i < N): offset + (width * (i - 1)).
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link.
LinkArgs
The set of arguments for Link. The set of arguments for Link.
LogExclusion
Specifies a set of log entries that are filtered out by a sink. If your Google Cloud resource receives a large volume of log entries, you can use exclusions to reduce your chargeable logs. Note that exclusions on organization-level and folder-level sinks don't apply to child resources. Note also that you cannot modify the _Required sink or exclude logs from it.
LogExclusionResponse
Specifies a set of log entries that are filtered out by a sink. If your Google Cloud resource receives a large volume of log entries, you can use exclusions to reduce your chargeable logs. Note that exclusions on organization-level and folder-level sinks don't apply to child resources. Note also that you cannot modify the _Required sink or exclude logs from it.
Metric
Creates a logs-based metric.
MetricArgs
The set of arguments for Metric. The set of arguments for Metric.
MetricDescriptor
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
MetricDescriptorMetadata
Additional annotations that can be used to guide the usage of a metric.
MetricDescriptorMetadataResponse
Additional annotations that can be used to guide the usage of a metric.
MetricDescriptorResponse
Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.
OrganizationBucket
Creates a log bucket that can be used to store log entries. After a bucket has been created, the bucket's location cannot be changed. Auto-naming is currently not supported for this resource.
OrganizationBucketArgs
The set of arguments for OrganizationBucket. The set of arguments for OrganizationBucket.
Asynchronously creates a linked dataset in BigQuery which makes it possible to use BigQuery to read the logs stored in the log bucket. A log bucket may currently only contain one link. Auto-naming is currently not supported for this resource.
OrganizationBucketLinkArgs
The set of arguments for OrganizationBucketLink. The set of arguments for OrganizationBucketLink.
OrganizationBucketView
Creates a view over log entries in a log bucket. A bucket may contain a maximum of 30 views. Auto-naming is currently not supported for this resource.
OrganizationBucketViewArgs
The set of arguments for OrganizationBucketView. The set of arguments for OrganizationBucketView.
OrganizationExclusion
Creates a new exclusion in the _Default sink 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.
OrganizationExclusionArgs
The set of arguments for OrganizationExclusion. The set of arguments for OrganizationExclusion.
OrganizationSink
Creates a sink that exports specified log entries to a destination. The export begins upon ingress, 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.
OrganizationSinkArgs
The set of arguments for OrganizationSink. The set of arguments for OrganizationSink.
Sink
Creates a sink that exports specified log entries to a destination. The export begins upon ingress, 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.
SinkArgs
The set of arguments for Sink. The set of arguments for Sink.

Enums

BillingAccountSinkOutputVersionFormat
Deprecated. This field is unused.
FolderSinkOutputVersionFormat
Deprecated. This field is unused.
IndexConfigType
Required. The type of data in this index.
LabelDescriptorValueType
The type of data that can be assigned to the label.
MetricDescriptorLaunchStage
Optional. The launch stage of the metric definition.
MetricDescriptorMetadataLaunchStage
Deprecated. Must use the MetricDescriptor.launch_stage instead.
MetricDescriptorMetricKind
Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.
MetricDescriptorValueType
Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.
MetricVersion
Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.
OrganizationSinkOutputVersionFormat
Deprecated. This field is unused.
SinkOutputVersionFormat
Deprecated. This field is unused.

Functions

getBillingAccountBucket(GetBillingAccountBucketArgs args, {InvokeOptions? options}) → Future<GetBillingAccountBucketResult>
Gets a log bucket. args Arguments passed to this invoke. Arguments for getBillingAccountBucket. options Invoke options controlling this call.
Gets a link. args Arguments passed to this invoke. Arguments for getBillingAccountBucketLink. options Invoke options controlling this call.
getBillingAccountBucketView(GetBillingAccountBucketViewArgs args, {InvokeOptions? options}) → Future<GetBillingAccountBucketViewResult>
Gets a view on a log bucket. args Arguments passed to this invoke. Arguments for getBillingAccountBucketView. options Invoke options controlling this call.
getBillingAccountExclusion(GetBillingAccountExclusionArgs args, {InvokeOptions? options}) → Future<GetBillingAccountExclusionResult>
Gets the description of an exclusion in the _Default sink. args Arguments passed to this invoke. Arguments for getBillingAccountExclusion. options Invoke options controlling this call.
getBillingAccountSink(GetBillingAccountSinkArgs args, {InvokeOptions? options}) → Future<GetBillingAccountSinkResult>
Gets a sink. args Arguments passed to this invoke. Arguments for getBillingAccountSink. options Invoke options controlling this call.
getBucket(GetBucketArgs args, {InvokeOptions? options}) → Future<GetBucketResult>
Gets a log bucket. args Arguments passed to this invoke. Arguments for getBucket. options Invoke options controlling this call.
getBucketView(GetBucketViewArgs args, {InvokeOptions? options}) → Future<GetBucketViewResult>
Gets a view on a log bucket. args Arguments passed to this invoke. Arguments for getBucketView. options Invoke options controlling this call.
getExclusion(GetExclusionArgs args, {InvokeOptions? options}) → Future<GetExclusionResult>
Gets the description of an exclusion in the _Default sink. args Arguments passed to this invoke. Arguments for getExclusion. options Invoke options controlling this call.
getFolderBucket(GetFolderBucketArgs args, {InvokeOptions? options}) → Future<GetFolderBucketResult>
Gets a log bucket. args Arguments passed to this invoke. Arguments for getFolderBucket. options Invoke options controlling this call.
Gets a link. args Arguments passed to this invoke. Arguments for getFolderBucketLink. options Invoke options controlling this call.
getFolderBucketView(GetFolderBucketViewArgs args, {InvokeOptions? options}) → Future<GetFolderBucketViewResult>
Gets a view on a log bucket. args Arguments passed to this invoke. Arguments for getFolderBucketView. options Invoke options controlling this call.
getFolderExclusion(GetFolderExclusionArgs args, {InvokeOptions? options}) → Future<GetFolderExclusionResult>
Gets the description of an exclusion in the _Default sink. args Arguments passed to this invoke. Arguments for getFolderExclusion. options Invoke options controlling this call.
getFolderSink(GetFolderSinkArgs args, {InvokeOptions? options}) → Future<GetFolderSinkResult>
Gets a sink. args Arguments passed to this invoke. Arguments for getFolderSink. options Invoke options controlling this call.
Gets a link. args Arguments passed to this invoke. Arguments for getLink. options Invoke options controlling this call.
getMetric(GetMetricArgs args, {InvokeOptions? options}) → Future<GetMetricResult>
Gets a logs-based metric. args Arguments passed to this invoke. Arguments for getMetric. options Invoke options controlling this call.
getOrganizationBucket(GetOrganizationBucketArgs args, {InvokeOptions? options}) → Future<GetOrganizationBucketResult>
Gets a log bucket. args Arguments passed to this invoke. Arguments for getOrganizationBucket. options Invoke options controlling this call.
Gets a link. args Arguments passed to this invoke. Arguments for getOrganizationBucketLink. options Invoke options controlling this call.
getOrganizationBucketView(GetOrganizationBucketViewArgs args, {InvokeOptions? options}) → Future<GetOrganizationBucketViewResult>
Gets a view on a log bucket. args Arguments passed to this invoke. Arguments for getOrganizationBucketView. options Invoke options controlling this call.
getOrganizationExclusion(GetOrganizationExclusionArgs args, {InvokeOptions? options}) → Future<GetOrganizationExclusionResult>
Gets the description of an exclusion in the _Default sink. args Arguments passed to this invoke. Arguments for getOrganizationExclusion. options Invoke options controlling this call.
getOrganizationSink(GetOrganizationSinkArgs args, {InvokeOptions? options}) → Future<GetOrganizationSinkResult>
Gets a sink. args Arguments passed to this invoke. Arguments for getOrganizationSink. options Invoke options controlling this call.
getSink(GetSinkArgs args, {InvokeOptions? options}) → Future<GetSinkResult>
Gets a sink. args Arguments passed to this invoke. Arguments for getSink. options Invoke options controlling this call.