Package-level declarations

Types

Link copied to clipboard
data class BigQueryDatasetResponse(val datasetId: String)

Describes a BigQuery dataset that was created by a link.

Link copied to clipboard
data class BigQueryOptionsResponse(val usePartitionedTables: Boolean, val usesTimestampColumnPartitioning: Boolean)

Options that change functionality of a sink exporting data to BigQuery.

Link copied to clipboard
data class BucketOptionsResponse(val explicitBuckets: ExplicitResponse, val exponentialBuckets: ExponentialResponse, val linearBuckets: LinearResponse)

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.

Link copied to clipboard
data class CmekSettingsResponse(val kmsKeyName: String, val kmsKeyVersionName: String, val name: String, val serviceAccountId: String)

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.

Link copied to clipboard
data class ExplicitResponse(val bounds: List<Double>)

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.

Link copied to clipboard
data class ExponentialResponse(val growthFactor: Double, val numFiniteBuckets: Int, val scale: Double)

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)).

Link copied to clipboard
data class GetBillingAccountBucketLinkResult(val bigqueryDataset: BigQueryDatasetResponse, val createTime: String, val description: String, val lifecycleState: String, val name: String)
Link copied to clipboard
data class GetBillingAccountBucketResult(val analyticsEnabled: Boolean, val cmekSettings: CmekSettingsResponse, val createTime: String, val description: String, val indexConfigs: List<IndexConfigResponse>, val lifecycleState: String, val locked: Boolean, val name: String, val restrictedFields: List<String>, val retentionDays: Int, val updateTime: String)
Link copied to clipboard
data class GetBillingAccountBucketViewResult(val createTime: String, val description: String, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetBillingAccountExclusionResult(val createTime: String, val description: String, val disabled: Boolean, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetBillingAccountSinkResult(val bigqueryOptions: BigQueryOptionsResponse, val createTime: String, val description: String, val destination: String, val disabled: Boolean, val exclusions: List<LogExclusionResponse>, val filter: String, val includeChildren: Boolean, val name: String, val outputVersionFormat: String, val updateTime: String, val writerIdentity: String)
Link copied to clipboard
data class GetBucketResult(val analyticsEnabled: Boolean, val cmekSettings: CmekSettingsResponse, val createTime: String, val description: String, val indexConfigs: List<IndexConfigResponse>, val lifecycleState: String, val locked: Boolean, val name: String, val restrictedFields: List<String>, val retentionDays: Int, val updateTime: String)
Link copied to clipboard
data class GetBucketViewResult(val createTime: String, val description: String, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetExclusionResult(val createTime: String, val description: String, val disabled: Boolean, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetFolderBucketLinkResult(val bigqueryDataset: BigQueryDatasetResponse, val createTime: String, val description: String, val lifecycleState: String, val name: String)
Link copied to clipboard
data class GetFolderBucketResult(val analyticsEnabled: Boolean, val cmekSettings: CmekSettingsResponse, val createTime: String, val description: String, val indexConfigs: List<IndexConfigResponse>, val lifecycleState: String, val locked: Boolean, val name: String, val restrictedFields: List<String>, val retentionDays: Int, val updateTime: String)
Link copied to clipboard
data class GetFolderBucketViewResult(val createTime: String, val description: String, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetFolderExclusionResult(val createTime: String, val description: String, val disabled: Boolean, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetFolderSinkResult(val bigqueryOptions: BigQueryOptionsResponse, val createTime: String, val description: String, val destination: String, val disabled: Boolean, val exclusions: List<LogExclusionResponse>, val filter: String, val includeChildren: Boolean, val name: String, val outputVersionFormat: String, val updateTime: String, val writerIdentity: String)
Link copied to clipboard
data class GetLinkResult(val bigqueryDataset: BigQueryDatasetResponse, val createTime: String, val description: String, val lifecycleState: String, val name: String)
Link copied to clipboard
data class GetMetricResult(val bucketName: String, val bucketOptions: BucketOptionsResponse, val createTime: String, val description: String, val disabled: Boolean, val filter: String, val labelExtractors: Map<String, String>, val metricDescriptor: MetricDescriptorResponse, val name: String, val updateTime: String, val valueExtractor: String, val version: String)
Link copied to clipboard
data class GetOrganizationBucketLinkResult(val bigqueryDataset: BigQueryDatasetResponse, val createTime: String, val description: String, val lifecycleState: String, val name: String)
Link copied to clipboard
data class GetOrganizationBucketResult(val analyticsEnabled: Boolean, val cmekSettings: CmekSettingsResponse, val createTime: String, val description: String, val indexConfigs: List<IndexConfigResponse>, val lifecycleState: String, val locked: Boolean, val name: String, val restrictedFields: List<String>, val retentionDays: Int, val updateTime: String)
Link copied to clipboard
data class GetOrganizationBucketViewResult(val createTime: String, val description: String, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetOrganizationExclusionResult(val createTime: String, val description: String, val disabled: Boolean, val filter: String, val name: String, val updateTime: String)
Link copied to clipboard
data class GetOrganizationSinkResult(val bigqueryOptions: BigQueryOptionsResponse, val createTime: String, val description: String, val destination: String, val disabled: Boolean, val exclusions: List<LogExclusionResponse>, val filter: String, val includeChildren: Boolean, val name: String, val outputVersionFormat: String, val updateTime: String, val writerIdentity: String)
Link copied to clipboard
data class GetSinkResult(val bigqueryOptions: BigQueryOptionsResponse, val createTime: String, val description: String, val destination: String, val disabled: Boolean, val exclusions: List<LogExclusionResponse>, val filter: String, val includeChildren: Boolean, val name: String, val outputVersionFormat: String, val updateTime: String, val writerIdentity: String)
Link copied to clipboard
data class IndexConfigResponse(val createTime: String, val fieldPath: String, val type: String)

Configuration for an indexed field.

Link copied to clipboard
data class LabelDescriptorResponse(val description: String, val key: String, val valueType: String)

A description of a label.

Link copied to clipboard
data class LinearResponse(val numFiniteBuckets: Int, val offset: Double, val width: Double)

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)).

Link copied to clipboard
data class LogExclusionResponse(val createTime: String, val description: String, val disabled: Boolean, val filter: String, val name: String, val updateTime: String)

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.

Link copied to clipboard
data class MetricDescriptorMetadataResponse(val ingestDelay: String, val launchStage: String, val samplePeriod: String)

Additional annotations that can be used to guide the usage of a metric.

Link copied to clipboard
data class MetricDescriptorResponse(val description: String, val displayName: String, val labels: List<LabelDescriptorResponse>, val launchStage: String, val metadata: MetricDescriptorMetadataResponse, val metricKind: String, val monitoredResourceTypes: List<String>, val name: String, val type: String, val unit: String, val valueType: String)

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.