Cloud Logging API Server

# generated by fastapi-codegen: # filename: openapi.yaml # timestamp: 2025-06-29T02:23:29+00:00 from __future__ import annotations from enum import Enum from typing import Any, Dict, List, Optional from pydantic import BaseModel, Field, RootModel class BigQueryDataset(BaseModel): datasetId: Optional[str] = Field( None, description='Output only. The full resource name of the BigQuery dataset. The DATASET_ID will match the ID of the link, so the link must match the naming restrictions of BigQuery datasets (alphanumeric characters and underscores only).The dataset will have a resource path of "bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID"', ) class BigQueryOptions(BaseModel): usePartitionedTables: Optional[bool] = Field( None, description="Optional. Whether to use BigQuery's partition tables (https://cloud.google.com/bigquery/docs/partitioned-tables). By default, Cloud Logging creates dated tables based on the log entries' timestamps, e.g. syslog_20170523. With partitioned tables the date suffix is no longer present and special query syntax (https://cloud.google.com/bigquery/docs/querying-partitioned-tables) has to be used instead. In both cases, tables are sharded based on UTC timezone.", ) usesTimestampColumnPartitioning: Optional[bool] = Field( None, description='Output only. True if new timestamp column based partitioning is in use, false if legacy ingestion-time partitioning is in use.All new sinks will have this field set true and will use timestamp column based partitioning. If use_partitioned_tables is false, this value has no meaning and will be false. Legacy sinks using partitioned tables will have this field set to false.', ) class State(Enum): OPERATION_STATE_UNSPECIFIED = 'OPERATION_STATE_UNSPECIFIED' OPERATION_STATE_SCHEDULED = 'OPERATION_STATE_SCHEDULED' OPERATION_STATE_WAITING_FOR_PERMISSIONS = 'OPERATION_STATE_WAITING_FOR_PERMISSIONS' OPERATION_STATE_RUNNING = 'OPERATION_STATE_RUNNING' OPERATION_STATE_SUCCEEDED = 'OPERATION_STATE_SUCCEEDED' OPERATION_STATE_FAILED = 'OPERATION_STATE_FAILED' OPERATION_STATE_CANCELLED = 'OPERATION_STATE_CANCELLED' class CancelOperationRequest(BaseModel): pass class CmekSettings(BaseModel): kmsKeyName: Optional[str] = Field( None, description='The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required cloudkms.cryptoKeyEncrypterDecrypter roles assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name or disabled by setting the key name to an empty string. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.', ) kmsKeyVersionName: Optional[str] = Field( None, description='The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSION]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key/cryptoKeyVersions/1"This is a read-only field used to convey the specific configured CryptoKeyVersion of kms_key that has been configured. It will be populated in cases where the CMEK settings are bound to a single key version.If this field is populated, the kms_key is tied to a specific CryptoKeyVersion.', ) name: Optional[str] = Field( None, description='Output only. The resource name of the CMEK settings.' ) serviceAccountId: Optional[str] = Field( None, description='Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the cloudkms.cryptoKeyEncrypterDecrypter role to the service account that the Log Router will use to access your Cloud KMS key. Use GetCmekSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.', ) class CopyLogEntriesRequest(BaseModel): destination: Optional[str] = Field( None, description='Required. Destination to which to copy log entries.' ) filter: Optional[str] = Field( None, description='Optional. A filter specifying which log entries to copy. The filter must be no more than 20k characters. An empty filter matches all log entries.', ) name: Optional[str] = Field( None, description='Required. Log bucket from which to copy log entries.For example:"projects/my-project/locations/global/buckets/my-source-bucket"', ) class CopyLogEntriesResponse(BaseModel): logEntriesCopiedCount: Optional[str] = Field( None, description='Number of log entries copied.' ) class DeleteLinkRequest(BaseModel): name: Optional[str] = Field( None, description='Required. The full resource name of the link to delete."projects/PROJECT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/links/LINK_ID" "organizations/ORGANIZATION_ID/locations/LOCATION_ID/buckets/BUCKET_ID/links/LINK_ID" "billingAccounts/BILLING_ACCOUNT_ID/locations/LOCATION_ID/buckets/BUCKET_ID/links/LINK_ID" "folders/FOLDER_ID/locations/LOCATION_ID/buckets/BUCKET_ID/links/LINK_ID"', ) class Empty(BaseModel): pass class Explicit(BaseModel): bounds: Optional[List[float]] = Field( None, description='The values must be monotonically increasing.' ) class Exponential(BaseModel): growthFactor: Optional[float] = Field(None, description='Must be greater than 1.') numFiniteBuckets: Optional[int] = Field(None, description='Must be greater than 0.') scale: Optional[float] = Field(None, description='Must be greater than 0.') class HttpRequest(BaseModel): cacheFillBytes: Optional[str] = Field( None, description='The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.', ) cacheHit: Optional[bool] = Field( None, description='Whether or not an entity was served from cache (with or without validation).', ) cacheLookup: Optional[bool] = Field( None, description='Whether or not a cache lookup was attempted.' ) cacheValidatedWithOriginServer: Optional[bool] = Field( None, description='Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.', ) latency: Optional[str] = Field( None, description='The request processing latency on the server, from the time the request was received until the response was sent.', ) protocol: Optional[str] = Field( None, description='Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2", "websocket"', ) referer: Optional[str] = Field( None, description='The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).', ) remoteIp: Optional[str] = Field( None, description='The IP address (IPv4 or IPv6) of the client that issued the HTTP request. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".', ) requestMethod: Optional[str] = Field( None, description='The request method. Examples: "GET", "HEAD", "PUT", "POST".' ) requestSize: Optional[str] = Field( None, description='The size of the HTTP request message in bytes, including the request headers and the request body.', ) requestUrl: Optional[str] = Field( None, description='The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: "http://example.com/some/info?color=red".', ) responseSize: Optional[str] = Field( None, description='The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.', ) serverIp: Optional[str] = Field( None, description='The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: "192.168.1.1", "10.0.0.1:80", "FE80::0202:B3FF:FE1E:8329".', ) status: Optional[int] = Field( None, description='The response code indicating the status of response. Examples: 200, 404.', ) userAgent: Optional[str] = Field( None, description='The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)".', ) class Type(Enum): INDEX_TYPE_UNSPECIFIED = 'INDEX_TYPE_UNSPECIFIED' INDEX_TYPE_STRING = 'INDEX_TYPE_STRING' INDEX_TYPE_INTEGER = 'INDEX_TYPE_INTEGER' class IndexConfig(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The timestamp when the index was last modified.This is used to return the timestamp, and will be ignored if supplied during update.', ) fieldPath: Optional[str] = Field( None, description='Required. The LogEntry field path to index.Note that some paths are automatically indexed, and other paths are not eligible for indexing. See indexing documentation( https://cloud.google.com/logging/docs/view/advanced-queries#indexed-fields) for details.For example: jsonPayload.request.status', ) type: Optional[Type] = Field( None, description='Required. The type of data in this index.' ) class ValueType(Enum): STRING = 'STRING' BOOL = 'BOOL' INT64 = 'INT64' class LabelDescriptor(BaseModel): description: Optional[str] = Field( None, description='A human-readable description for the label.' ) key: Optional[str] = Field(None, description='The label key.') valueType: Optional[ValueType] = Field( None, description='The type of data that can be assigned to the label.' ) class Linear(BaseModel): numFiniteBuckets: Optional[int] = Field(None, description='Must be greater than 0.') offset: Optional[float] = Field( None, description='Lower bound of the first bucket.' ) width: Optional[float] = Field(None, description='Must be greater than 0.') class LifecycleState(Enum): LIFECYCLE_STATE_UNSPECIFIED = 'LIFECYCLE_STATE_UNSPECIFIED' ACTIVE = 'ACTIVE' DELETE_REQUESTED = 'DELETE_REQUESTED' UPDATING = 'UPDATING' CREATING = 'CREATING' FAILED = 'FAILED' class Link(BaseModel): bigqueryDataset: Optional[BigQueryDataset] = Field( None, description="The information of a BigQuery Dataset. When a link is created, a BigQuery dataset is created along with it, in the same project as the LogBucket it's linked to. This dataset will also have BigQuery Views corresponding to the LogViews in the bucket.", ) createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the link.' ) description: Optional[str] = Field( None, description='Describes this link.The maximum length of the description is 8000 characters.', ) lifecycleState: Optional[LifecycleState] = Field( None, description='Output only. The resource lifecycle state.' ) name: Optional[str] = Field( None, description='The resource name of the link. The name can have up to 100 characters. A valid link id (at the end of the link name) must only have alphanumeric characters and underscores within it. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my-bucket/links/my_link', ) class ListLinksResponse(BaseModel): links: Optional[List[Link]] = Field(None, description='A list of links.') nextPageToken: Optional[str] = Field( None, description='If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.', ) class ListLogEntriesRequest(BaseModel): filter: Optional[str] = Field( None, description='Optional. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of a filter is 20,000 characters.', ) orderBy: Optional[str] = Field( None, description='Optional. How the results should be sorted. Presently, the only permitted values are "timestamp asc" (default) and "timestamp desc". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.', ) pageSize: Optional[int] = Field( None, description='Optional. The maximum number of results to return from this request. Default is 50. If the value is negative or exceeds 1000, the request is rejected. The presence of next_page_token in the response indicates that more results might be available.', ) pageToken: Optional[str] = Field( None, description='Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.', ) projectIds: Optional[List[str]] = Field( None, description='Optional. Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A".', ) resourceNames: Optional[List[str]] = Field( None, description='Required. Names of one or more parent resources from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]Projects listed in the project_ids field are added to this list. A maximum of 100 resources may be specified in a single request.', ) class ListLogsResponse(BaseModel): logNames: Optional[List[str]] = Field( None, description='A list of log names. For example, "projects/my-project/logs/syslog" or "organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity".', ) nextPageToken: Optional[str] = Field( None, description='If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.', ) class Location(BaseModel): displayName: Optional[str] = Field( None, description='The friendly name for this location, typically a nearby city name. For example, "Tokyo".', ) labels: Optional[Dict[str, str]] = Field( None, description='Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} ', ) locationId: Optional[str] = Field( None, description='The canonical id for this location. For example: "us-east1".' ) metadata: Optional[Dict[str, Any]] = Field( None, description='Service-specific metadata. For example the available capacity at the given location.', ) name: Optional[str] = Field( None, description='Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"', ) class LocationMetadata(BaseModel): logAnalyticsEnabled: Optional[bool] = Field( None, description='Indicates whether or not Log Analytics features are supported in the given location.', ) class LogBucket(BaseModel): analyticsEnabled: Optional[bool] = Field( None, description='Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled.', ) cmekSettings: Optional[CmekSettings] = Field( None, description='The CMEK settings of the log bucket. If present, new log entries written to this log bucket are encrypted using the CMEK key provided in this configuration. If a log bucket has CMEK settings, the CMEK settings cannot be disabled later by updating the log bucket. Changing the KMS key is allowed.', ) createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the bucket. This is not set for any of the default buckets.', ) description: Optional[str] = Field(None, description='Describes this bucket.') indexConfigs: Optional[List[IndexConfig]] = Field( None, description='A list of indexed fields and related configuration data.' ) lifecycleState: Optional[LifecycleState] = Field( None, description='Output only. The bucket lifecycle state.' ) locked: Optional[bool] = Field( None, description='Whether the bucket is locked.The retention period on a locked bucket cannot be changed. Locked buckets may only be deleted if they are empty.', ) name: Optional[str] = Field( None, description='Output only. The resource name of the bucket.For example:projects/my-project/locations/global/buckets/my-bucketFor a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)For the location of global it is unspecified where log entries are actually stored.After a bucket has been created, the location cannot be changed.', ) restrictedFields: Optional[List[str]] = Field( None, description='Log entry field paths that are denied access in this bucket.The following fields and their children are eligible: textPayload, jsonPayload, protoPayload, httpRequest, labels, sourceLocation.Restricting a repeated field will restrict all values. Adding a parent will block all child fields. (e.g. foo.bar will block foo.bar.baz)', ) retentionDays: Optional[int] = Field( None, description='Logs will be retained by default for this amount of time, after which they will automatically be deleted. The minimum retention period is 1 day. If this value is set to zero at bucket creation time, the default time of 30 days will be used.', ) updateTime: Optional[str] = Field( None, description='Output only. The last update timestamp of the bucket.' ) class Severity(Enum): DEFAULT = 'DEFAULT' DEBUG = 'DEBUG' INFO = 'INFO' NOTICE = 'NOTICE' WARNING = 'WARNING' ERROR = 'ERROR' CRITICAL = 'CRITICAL' ALERT = 'ALERT' EMERGENCY = 'EMERGENCY' class LogEntryOperation(BaseModel): first: Optional[bool] = Field( None, description='Optional. Set this to True if this is the first log entry in the operation.', ) id: Optional[str] = Field( None, description='Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation.', ) last: Optional[bool] = Field( None, description='Optional. Set this to True if this is the last log entry in the operation.', ) producer: Optional[str] = Field( None, description='Optional. An arbitrary producer identifier. The combination of id and producer must be globally unique. Examples for producer: "MyDivision.MyBigCompany.com", "github.com/MyProject/MyApplication".', ) class LogEntrySourceLocation(BaseModel): file: Optional[str] = Field( None, description='Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.', ) function: Optional[str] = Field( None, description='Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).', ) line: Optional[str] = Field( None, description='Optional. Line within the source file. 1-based; 0 indicates no line number available.', ) class LogExclusion(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions.', ) description: Optional[str] = Field( None, description='Optional. A description of this exclusion.' ) disabled: Optional[bool] = Field( None, description='Optional. If set to True, then this exclusion is disabled and it does not exclude any log entries. You can update an exclusion to change the value of this field.', ) filter: Optional[str] = Field( None, description='Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries) that matches the log entries to be excluded. By using the sample function (https://cloud.google.com/logging/docs/view/advanced-queries#sample), you can exclude less than 100% of the matching log entries.For example, the following query matches 99% of low-severity log entries from Google Cloud Storage buckets:resource.type=gcs_bucket severity<ERROR sample(insertId, 0.99)', ) name: Optional[str] = Field( None, description='Required. A client-assigned identifier, such as "load-balancer-exclusion". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric.', ) updateTime: Optional[str] = Field( None, description='Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions.', ) class Version(Enum): V2 = 'V2' V1 = 'V1' class OutputVersionFormat(Enum): VERSION_FORMAT_UNSPECIFIED = 'VERSION_FORMAT_UNSPECIFIED' V2 = 'V2' V1 = 'V1' class LogSink(BaseModel): bigqueryOptions: Optional[BigQueryOptions] = Field( None, description='Optional. Options that affect sinks exporting data to BigQuery.', ) createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the sink.This field may not be present for older sinks.', ) description: Optional[str] = Field( None, description='Optional. A description of this sink.The maximum length of the description is 8000 characters.', ) destination: Optional[str] = Field( None, description='Required. The export destination: "storage.googleapis.com/[GCS_BUCKET]" "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" "pubsub.googleapis.com/projects/[PROJECT_ID]/topics/[TOPIC_ID]" The sink\'s writer_identity, set when the sink is created, must have permission to write to the destination or else the log entries are not exported. For more information, see Exporting Logs with Sinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).', ) disabled: Optional[bool] = Field( None, description='Optional. If set to true, then this sink is disabled and it does not export any log entries.', ) exclusions: Optional[List[LogExclusion]] = Field( None, description='Optional. Log entries that match any of these exclusion filters will not be exported.If a log entry is matched by both filter and one of exclusion_filters it will not be exported.', ) filter: Optional[str] = Field( None, description='Optional. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced-queries). The only exported log entries are those that are in the resource owning the sink and that match the filter.For example:logName="projects/[PROJECT_ID]/logs/[LOG_ID]" AND severity>=ERROR', ) includeChildren: Optional[bool] = Field( None, description='Optional. This field applies only to sinks owned by organizations and folders. If the field is false, the default, only the logs owned by the sink\'s parent resource are available for export. If the field is true, then log entries from all the projects, folders, and billing accounts contained in the sink\'s parent resource are also available for export. Whether a particular log entry from the children is exported depends on the sink\'s filter expression.For example, if this field is true, then the filter resource.type=gce_instance would export all Compute Engine VM instance log entries from all projects in the sink\'s parent.To only export entries from certain child projects, filter on the project part of the log name:logName:("projects/test-project1/" OR "projects/test-project2/") AND resource.type=gce_instance', ) name: Optional[str] = Field( None, description='Required. The client-assigned sink identifier, unique within the project.For example: "my-syslog-errors-to-pubsub". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. First character has to be alphanumeric.', ) outputVersionFormat: Optional[OutputVersionFormat] = Field( None, description='Deprecated. This field is unused.' ) updateTime: Optional[str] = Field( None, description='Output only. The last update timestamp of the sink.This field may not be present for older sinks.', ) writerIdentity: Optional[str] = Field( None, description="Output only. An IAM identity—a service account or group—under which Cloud Logging writes the exported log entries to the sink's destination. This field is either set by specifying custom_writer_identity or set automatically by sinks.create and sinks.update based on the value of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting Access for a Resource (https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.Sinks that have a destination that is a log bucket in the same project as the sink cannot have a writer_identity and no additional permissions are required.", ) class LogSplit(BaseModel): index: Optional[int] = Field( None, description='The index of this LogEntry in the sequence of split log entries. Log entries are given |index| values 0, 1, ..., n-1 for a sequence of n log entries.', ) totalSplits: Optional[int] = Field( None, description='The total number of log entries that the original LogEntry was split into.', ) uid: Optional[str] = Field( None, description='A globally unique identifier for all log entries in a sequence of split log entries. All log entries with the same |LogSplit.uid| are assumed to be part of the same sequence of split log entries.', ) class LogView(BaseModel): createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the view.' ) description: Optional[str] = Field(None, description='Describes this view.') filter: Optional[str] = Field( None, description='Filter that restricts which log entries in a bucket are visible in this view.Filters are restricted to be a logical AND of ==/!= of any of the following: originating project/folder/organization/billing account. resource type log idFor example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND LOG_ID("stdout")', ) name: Optional[str] = Field( None, description='The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view', ) updateTime: Optional[str] = Field( None, description='Output only. The last update timestamp of the view.' ) class LaunchStage(Enum): LAUNCH_STAGE_UNSPECIFIED = 'LAUNCH_STAGE_UNSPECIFIED' UNIMPLEMENTED = 'UNIMPLEMENTED' PRELAUNCH = 'PRELAUNCH' EARLY_ACCESS = 'EARLY_ACCESS' ALPHA = 'ALPHA' BETA = 'BETA' GA = 'GA' DEPRECATED = 'DEPRECATED' class MetricKind(Enum): METRIC_KIND_UNSPECIFIED = 'METRIC_KIND_UNSPECIFIED' GAUGE = 'GAUGE' DELTA = 'DELTA' CUMULATIVE = 'CUMULATIVE' class ValueType1(Enum): VALUE_TYPE_UNSPECIFIED = 'VALUE_TYPE_UNSPECIFIED' BOOL = 'BOOL' INT64 = 'INT64' DOUBLE = 'DOUBLE' STRING = 'STRING' DISTRIBUTION = 'DISTRIBUTION' MONEY = 'MONEY' class MetricDescriptorMetadata(BaseModel): ingestDelay: Optional[str] = Field( None, description='The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors.', ) launchStage: Optional[LaunchStage] = Field( None, description='Deprecated. Must use the MetricDescriptor.launch_stage instead.', ) samplePeriod: Optional[str] = Field( None, description='The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors. Metrics with a higher granularity have a smaller sampling period.', ) class MonitoredResource(BaseModel): labels: Optional[Dict[str, str]] = Field( None, description='Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id", and "zone".', ) type: Optional[str] = Field( None, description='Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. Some descriptors include the service name in the type; for example, the type of a Datastream stream is datastream.googleapis.com/Stream.', ) class MonitoredResourceDescriptor(BaseModel): description: Optional[str] = Field( None, description='Optional. A detailed description of the monitored resource type that might be used in documentation.', ) displayName: Optional[str] = Field( None, description='Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, "Google Cloud SQL Database".', ) labels: Optional[List[LabelDescriptor]] = Field( None, description='Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels "database_id" and "zone".', ) launchStage: Optional[LaunchStage] = Field( None, description='Optional. The launch stage of the monitored resource definition.', ) name: Optional[str] = Field( None, description='Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format "monitoredResourceDescriptors/{type}".', ) type: Optional[str] = Field( None, description='Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).', ) class MonitoredResourceMetadata(BaseModel): systemLabels: Optional[Dict[str, Any]] = Field( None, description='Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } ', ) userLabels: Optional[Dict[str, str]] = Field( None, description='Output only. A map of user-defined metadata labels.' ) class Settings(BaseModel): disableDefaultSink: Optional[bool] = Field( None, description='Optional. If set to true, the _Default sink in newly created projects and folders will created in a disabled state. This can be used to automatically disable log ingestion if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed.', ) kmsKeyName: Optional[str] = Field( None, description='Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK for the Log Router, set this field to a valid kms_key_name for which the associated service account has the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key.The Cloud KMS key used by the Log Router can be updated by changing the kms_key_name to a new valid key name. Encryption operations that are in progress will be completed with the key that was in use when they started. Decryption operations will be completed using the key that was used at the time of encryption unless access to that key has been revoked.To disable CMEK for the Log Router, set this field to an empty string.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.', ) kmsServiceAccountId: Optional[str] = Field( None, description='Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK for Log Router, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that the Log Router will use to access your Cloud KMS key. Use GetSettings to obtain the service account ID.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information.', ) name: Optional[str] = Field( None, description='Output only. The resource name of the settings.' ) storageLocation: Optional[str] = Field( None, description='Optional. The Cloud region that will be used for _Default and _Required log buckets for newly created projects and folders. For example europe-west1. This setting does not affect the location of custom log buckets.', ) class SourceLocation(BaseModel): file: Optional[str] = Field( None, description='Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.', ) functionName: Optional[str] = Field( None, description='Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).', ) line: Optional[str] = Field(None, description='Line within the source file.') class SourceReference(BaseModel): repository: Optional[str] = Field( None, description='Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git"', ) revisionId: Optional[str] = Field( None, description='The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b"', ) class Status(BaseModel): code: Optional[int] = Field( None, description='The status code, which should be an enum value of google.rpc.Code.', ) details: Optional[List[Dict[str, Any]]] = Field( None, description='A list of messages that carry the error details. There is a common set of message types for APIs to use.', ) message: Optional[str] = Field( None, description='A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.', ) class Reason(Enum): REASON_UNSPECIFIED = 'REASON_UNSPECIFIED' RATE_LIMIT = 'RATE_LIMIT' NOT_CONSUMED = 'NOT_CONSUMED' class SuppressionInfo(BaseModel): reason: Optional[Reason] = Field( None, description='The reason that entries were omitted from the session.' ) suppressedCount: Optional[int] = Field( None, description='A lower bound on the count of entries omitted due to reason.' ) class TailLogEntriesRequest(BaseModel): bufferWindow: Optional[str] = Field( None, description='Optional. The amount of time to buffer log entries at the server before being returned to prevent out of order results due to late arriving log entries. Valid values are between 0-60000 milliseconds. Defaults to 2000 milliseconds.', ) filter: Optional[str] = Field( None, description='Optional. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of a filter is 20,000 characters.', ) resourceNames: Optional[List[str]] = Field( None, description='Required. Name of a parent resource from which to retrieve log entries: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]', ) class UndeleteBucketRequest(BaseModel): pass class UpdateBucketRequest(BaseModel): bucket: Optional[LogBucket] = Field( None, description='Required. The updated bucket.' ) name: Optional[str] = Field( None, description='Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" For example:"projects/my-project/locations/global/buckets/my-bucket"', ) updateMask: Optional[str] = Field( None, description='Required. Field mask that specifies the fields in bucket that need an update. A bucket field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.For a detailed FieldMask definition, see: https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=retention_days', ) class WriteLogEntriesResponse(BaseModel): pass class FieldXgafv(Enum): field_1 = '1' field_2 = '2' class Alt(Enum): json = 'json' media = 'media' proto = 'proto' class ResourceNames(RootModel[List[str]]): root: List[str] class BucketOptions(BaseModel): explicitBuckets: Optional[Explicit] = Field( None, description='The explicit buckets.' ) exponentialBuckets: Optional[Exponential] = Field( None, description='The exponential buckets.' ) linearBuckets: Optional[Linear] = Field(None, description='The linear bucket.') class CopyLogEntriesMetadata(BaseModel): cancellationRequested: Optional[bool] = Field( None, description='Identifies whether the user has requested cancellation of the operation.', ) endTime: Optional[str] = Field(None, description='The end time of an operation.') progress: Optional[int] = Field( None, description='Estimated progress of the operation (0 - 100%).' ) request: Optional[CopyLogEntriesRequest] = Field( None, description='CopyLogEntries RPC request.' ) startTime: Optional[str] = Field( None, description='The create time of an operation.' ) state: Optional[State] = Field(None, description='State of an operation.') writerIdentity: Optional[str] = Field( None, description='The IAM identity of a service account that must be granted access to the destination.If the service account is not granted permission to the destination within an hour, the operation will be cancelled.For example: "serviceAccount:foo@bar.com"', ) class CreateBucketRequest(BaseModel): bucket: Optional[LogBucket] = Field( None, description='Required. The new bucket. The region specified in the new bucket must be compliant with any Location Restriction Org Policy. The name field in the bucket is ignored.', ) bucketId: Optional[str] = Field( None, description='Required. A client-assigned identifier such as "my-bucket". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.', ) parent: Optional[str] = Field( None, description='Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global"', ) class CreateLinkRequest(BaseModel): link: Optional[Link] = Field(None, description='Required. The new link.') linkId: Optional[str] = Field( None, description='Required. The ID to use for the link. The link_id can have up to 100 characters. A valid link_id must only have alphanumeric characters and underscores within it.', ) parent: Optional[str] = Field( None, description='Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" ', ) class LinkMetadata(BaseModel): createLinkRequest: Optional[CreateLinkRequest] = Field( None, description='CreateLink RPC request.' ) deleteLinkRequest: Optional[DeleteLinkRequest] = Field( None, description='DeleteLink RPC request.' ) endTime: Optional[str] = Field(None, description='The end time of an operation.') startTime: Optional[str] = Field( None, description='The start time of an operation.' ) state: Optional[State] = Field(None, description='State of an operation.') class ListBucketsResponse(BaseModel): buckets: Optional[List[LogBucket]] = Field(None, description='A list of buckets.') nextPageToken: Optional[str] = Field( None, description='If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.', ) class ListExclusionsResponse(BaseModel): exclusions: Optional[List[LogExclusion]] = Field( None, description='A list of exclusions.' ) nextPageToken: Optional[str] = Field( None, description='If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.', ) class ListLocationsResponse(BaseModel): locations: Optional[List[Location]] = Field( None, description='A list of locations that matches the specified filter in the request.', ) nextPageToken: Optional[str] = Field( None, description='The standard List next-page token.' ) class ListMonitoredResourceDescriptorsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.', ) resourceDescriptors: Optional[List[MonitoredResourceDescriptor]] = Field( None, description='A list of resource descriptors.' ) class ListSinksResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.', ) sinks: Optional[List[LogSink]] = Field(None, description='A list of sinks.') class ListViewsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.', ) views: Optional[List[LogView]] = Field(None, description='A list of views.') class LogEntry(BaseModel): httpRequest: Optional[HttpRequest] = Field( None, description='Optional. Information about the HTTP request associated with this log entry, if applicable.', ) insertId: Optional[str] = Field( None, description='Optional. A unique identifier for the log entry. If you provide a value, then Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which are removed in a single query result. However, there are no guarantees of de-duplication in the export of logs.If the insert_id is omitted when writing a log entry, the Logging API assigns its own unique identifier in this field.In queries, the insert_id is also used to order log entries that have the same log_name and timestamp values.', ) jsonPayload: Optional[Dict[str, Any]] = Field( None, description='The log entry payload, represented as a structure that is expressed as a JSON object.', ) labels: Optional[Dict[str, str]] = Field( None, description='Optional. A map of key, value pairs that provides additional information about the log entry. The labels can be user-defined or system-defined.User-defined labels are arbitrary key, value pairs that you can use to classify logs.System-defined labels are defined by GCP services for platform logs. They have two components - a service namespace component and the attribute name. For example: compute.googleapis.com/resource_name.Cloud Logging truncates label keys that exceed 512 B and label values that exceed 64 KB upon their associated log entry being written. The truncation is indicated by an ellipsis at the end of the character string.', ) logName: Optional[str] = Field( None, description='Required. The resource name of the log to which this log entry belongs: "projects/[PROJECT_ID]/logs/[LOG_ID]" "organizations/[ORGANIZATION_ID]/logs/[LOG_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]" "folders/[FOLDER_ID]/logs/[LOG_ID]" A project number may be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: "organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity".[LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual, but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.', ) metadata: Optional[MonitoredResourceMetadata] = Field( None, description='Output only. Deprecated. This field is not used by Logging. Any value written to it is cleared.', ) operation: Optional[LogEntryOperation] = Field( None, description='Optional. Information about an operation associated with the log entry, if applicable.', ) protoPayload: Optional[Dict[str, Any]] = Field( None, description='The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.The following protocol buffer types are supported; user-defined types are not supported:"type.googleapis.com/google.cloud.audit.AuditLog" "type.googleapis.com/google.appengine.logging.v1.RequestLog"', ) receiveTimestamp: Optional[str] = Field( None, description='Output only. The time the log entry was received by Logging.' ) resource: Optional[MonitoredResource] = Field( None, description='Required. The monitored resource that produced this log entry.Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.', ) severity: Optional[Severity] = Field( None, description='Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.', ) sourceLocation: Optional[LogEntrySourceLocation] = Field( None, description='Optional. Source code location information associated with the log entry, if any.', ) spanId: Optional[str] = Field( None, description='Optional. The ID of the Cloud Trace (https://cloud.google.com/trace) span associated with the current operation in which the log is being written. For example, if a span has the REST resource name of "projects/some-project/traces/some-trace/spans/some-span-id", then the span_id field is "some-span-id".A Span (https://cloud.google.com/trace/docs/reference/v2/rest/v2/projects.traces/batchWrite#Span) represents a single operation within a trace. Whereas a trace may involve multiple different microservices running on multiple different machines, a span generally corresponds to a single logical operation being performed in a single instance of a microservice on one specific machine. Spans are the nodes within the tree that is a trace.Applications that are instrumented for tracing (https://cloud.google.com/trace/docs/setup) will generally assign a new, unique span ID on each incoming request. It is also common to create and record additional spans corresponding to internal processing elements as well as issuing requests to dependencies.The span ID is expected to be a 16-character, hexadecimal encoding of an 8-byte array and should not be zero. It should be unique within the trace and should, ideally, be generated in a manner that is uniformly random.Example values: 000000000000004a 7a2190356c3fc94b 0000f00300090021 d39223e101960076', ) split: Optional[LogSplit] = Field( None, description='Optional. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry.', ) textPayload: Optional[str] = Field( None, description='The log entry payload, represented as a Unicode string (UTF-8).', ) timestamp: Optional[str] = Field( None, description="Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Logging assigns it the current time. Timestamps have nanosecond accuracy, but trailing zeros in the fractional seconds might be omitted when the timestamp is displayed.Incoming log entries must have timestamps that don't exceed the logs retention period (https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, and that don't exceed 24 hours in the future. Log entries outside those time boundaries aren't ingested by Logging.", ) trace: Optional[str] = Field( None, description='Optional. The REST resource name of the trace being written to Cloud Trace (https://cloud.google.com/trace) in association with this log entry. For example, if your trace data is stored in the Cloud project "my-trace-project" and if the service that is creating the log entry receives a trace header that includes the trace ID "12345", then the service should use "projects/my-tracing-project/traces/12345".The trace field provides the link between logs and traces. By using this field, you can navigate from a log entry to a trace.', ) traceSampled: Optional[bool] = Field( None, description='Optional. The sampling decision of the trace associated with the log entry.True means that the trace resource name in the trace field was sampled for storage in a trace backend. False means that the trace was not sampled for storage when this log entry was written, or the sampling decision was unknown at the time. A non-sampled trace value is still useful as a request correlation identifier. The default is False.', ) class LogLine(BaseModel): logMessage: Optional[str] = Field(None, description='App-provided log message.') severity: Optional[Severity] = Field( None, description='Severity of this log entry.' ) sourceLocation: Optional[SourceLocation] = Field( None, description='Where in the source code this log message was written.' ) time: Optional[str] = Field( None, description='Approximate time when this log entry was made.' ) class MetricDescriptor(BaseModel): description: Optional[str] = Field( None, description='A detailed description of the metric, which can be used in documentation.', ) displayName: Optional[str] = Field( None, description='A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.', ) labels: Optional[List[LabelDescriptor]] = Field( None, description='The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.', ) launchStage: Optional[LaunchStage] = Field( None, description='Optional. The launch stage of the metric definition.' ) metadata: Optional[MetricDescriptorMetadata] = Field( None, description='Optional. Metadata which can be used to guide usage of the metric.', ) metricKind: Optional[MetricKind] = Field( None, description='Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.', ) monitoredResourceTypes: Optional[List[str]] = Field( None, description='Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be associated with one of the monitored resource types listed here.', ) name: Optional[str] = Field( None, description='The resource name of the metric descriptor.' ) type: Optional[str] = Field( None, description='The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up" "appengine.googleapis.com/http/server/response_latencies" ', ) unit: Optional[str] = Field( None, description='The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy). However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day"). % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3 percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3 percent").', ) valueType: Optional[ValueType1] = Field( None, description='Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.', ) class Operation(BaseModel): done: Optional[bool] = Field( None, description='If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.', ) error: Optional[Status] = Field( None, description='The error result of the operation in case of failure or cancellation.', ) metadata: Optional[Dict[str, Any]] = Field( None, description='Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.', ) name: Optional[str] = Field( None, description='The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.', ) response: Optional[Dict[str, Any]] = Field( None, description='The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.', ) class RequestLog(BaseModel): appEngineRelease: Optional[str] = Field( None, description='App Engine release version.' ) appId: Optional[str] = Field( None, description='Application that handled this request.' ) cost: Optional[float] = Field( None, description='An indication of the relative cost of serving this request.' ) endTime: Optional[str] = Field(None, description='Time when the request finished.') finished: Optional[bool] = Field( None, description='Whether this request is finished or active.' ) first: Optional[bool] = Field( None, description='Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.', ) host: Optional[str] = Field( None, description='Internet host and port number of the resource being requested.', ) httpVersion: Optional[str] = Field( None, description='HTTP version of request. Example: "HTTP/1.1".' ) instanceId: Optional[str] = Field( None, description='An identifier for the instance that handled the request.' ) instanceIndex: Optional[int] = Field( None, description='If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.', ) ip: Optional[str] = Field(None, description='Origin IP address.') latency: Optional[str] = Field(None, description='Latency of the request.') line: Optional[List[LogLine]] = Field( None, description='A list of log lines emitted by the application while serving this request.', ) megaCycles: Optional[str] = Field( None, description='Number of CPU megacycles used to process request.' ) method: Optional[str] = Field( None, description='Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE".', ) moduleId: Optional[str] = Field( None, description='Module of the application that handled this request.' ) nickname: Optional[str] = Field( None, description="The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.", ) pendingTime: Optional[str] = Field( None, description='Time this request spent in the pending request queue.' ) referrer: Optional[str] = Field(None, description='Referrer URL of request.') requestId: Optional[str] = Field( None, description='Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.', ) resource: Optional[str] = Field( None, description='Contains the path and query portion of the URL that was requested. For example, if the URL was "http://example.com/app?name=val", the resource would be "/app?name=val". The fragment identifier, which is identified by the # character, is not included.', ) responseSize: Optional[str] = Field( None, description='Size in bytes sent back to client by request.' ) sourceReference: Optional[List[SourceReference]] = Field( None, description='Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.', ) spanId: Optional[str] = Field( None, description='Stackdriver Trace span identifier for this request.' ) startTime: Optional[str] = Field(None, description='Time when the request started.') status: Optional[int] = Field( None, description='HTTP response status code. Example: 200, 404.' ) taskName: Optional[str] = Field( None, description='Task name of the request, in the case of an offline request.' ) taskQueueName: Optional[str] = Field( None, description='Queue name of the request, in the case of an offline request.', ) traceId: Optional[str] = Field( None, description='Stackdriver Trace identifier for this request.' ) traceSampled: Optional[bool] = Field( None, description="If true, the value in the 'trace_id' field was sampled for storage in a trace backend.", ) urlMapEntry: Optional[str] = Field( None, description='File or class that handled the request.' ) userAgent: Optional[str] = Field( None, description='User agent that made the request.' ) versionId: Optional[str] = Field( None, description='Version of the application that handled this request.' ) wasLoadingRequest: Optional[bool] = Field( None, description='Whether this was a loading request for the instance.' ) class TailLogEntriesResponse(BaseModel): entries: Optional[List[LogEntry]] = Field( None, description='A list of log entries. Each response in the stream will order entries with increasing values of LogEntry.timestamp. Ordering is not guaranteed between separate responses.', ) suppressionInfo: Optional[List[SuppressionInfo]] = Field( None, description='If entries that otherwise would have been included in the session were not sent back to the client, counts of relevant entries omitted from the session with the reason that they were not included. There will be at most one of each reason per response. The counts represent the number of suppressed entries since the last streamed response.', ) class WriteLogEntriesRequest(BaseModel): dryRun: Optional[bool] = Field( None, description="Optional. If true, the request should expect normal response, but the entries won't be persisted nor exported. Useful for checking whether the logging API endpoints are working properly before sending valuable data.", ) entries: Optional[List[LogEntry]] = Field( None, description="Required. The log entries to send to Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period (https://cloud.google.com/logging/quotas) in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks (https://cloud.google.com/logging/docs/api/tasks/exporting-logs).To improve throughput and to avoid exceeding the quota limit (https://cloud.google.com/logging/quotas) for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.", ) labels: Optional[Dict[str, str]] = Field( None, description="Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.", ) logName: Optional[str] = Field( None, description='Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name: projects/[PROJECT_ID]/logs/[LOG_ID] organizations/[ORGANIZATION_ID]/logs/[LOG_ID] billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID] folders/[FOLDER_ID]/logs/[LOG_ID][LOG_ID] must be URL-encoded. For example: "projects/my-project-id/logs/syslog" "organizations/123/logs/cloudaudit.googleapis.com%2Factivity" The permission logging.logEntries.create is needed on each project, organization, billing account, or folder that is receiving new log entries, whether the resource is specified in logName or in an individual log entry.', ) partialSuccess: Optional[bool] = Field( None, description="Optional. Whether a batch's valid entries should be written even if some other entry failed due to a permanent error such as INVALID_ARGUMENT or PERMISSION_DENIED. If any entry failed, then the response status is the response status of one of the failed entries. The response will include error details in WriteLogEntriesPartialErrors.log_entry_errors keyed by the entries' zero-based index in the entries. Failed requests for which no entries are written will not include per-entry errors.", ) resource: Optional[MonitoredResource] = Field( None, description='Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example: { "type": "gce_instance", "labels": { "zone": "us-central1-a", "instance_id": "00000000000000000000" }} See LogEntry.', ) class BucketMetadata(BaseModel): createBucketRequest: Optional[CreateBucketRequest] = Field( None, description='LongRunningCreateBucket RPC request.' ) endTime: Optional[str] = Field(None, description='The end time of an operation.') startTime: Optional[str] = Field( None, description='The create time of an operation.' ) state: Optional[State] = Field(None, description='State of an operation.') updateBucketRequest: Optional[UpdateBucketRequest] = Field( None, description='LongRunningUpdateBucket RPC request.' ) class ListLogEntriesResponse(BaseModel): entries: Optional[List[LogEntry]] = Field( None, description='A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.', ) nextPageToken: Optional[str] = Field( None, description='If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.', ) class ListOperationsResponse(BaseModel): nextPageToken: Optional[str] = Field( None, description='The standard List next-page token.' ) operations: Optional[List[Operation]] = Field( None, description='A list of operations that matches the specified filter in the request.', ) class LogMetric(BaseModel): bucketName: Optional[str] = Field( None, description='Optional. The resource name of the Log Bucket that owns the Log Metric. Only Log Buckets in projects are supported. The bucket has to be in the same project as the metric.For example:projects/my-project/locations/global/buckets/my-bucketIf empty, then the Log Metric is considered a non-Bucket Log Metric.', ) bucketOptions: Optional[BucketOptions] = Field( None, description='Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.', ) createTime: Optional[str] = Field( None, description='Output only. The creation timestamp of the metric.This field may not be present for older metrics.', ) description: Optional[str] = Field( None, description='Optional. A description of this metric, which is used in documentation. The maximum length of the description is 8000 characters.', ) disabled: Optional[bool] = Field( None, description='Optional. If set to True, then this metric is disabled and it does not generate any points.', ) filter: Optional[str] = Field( None, description='Required. An advanced logs filter (https://cloud.google.com/logging/docs/view/advanced_filters) which is used to match log entries. Example: "resource.type=gae_app AND severity>=ERROR" The maximum length of the filter is 20000 characters.', ) labelExtractors: Optional[Dict[str, str]] = Field( None, description='Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.', ) metricDescriptor: Optional[MetricDescriptor] = Field( None, description='Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of "1". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.', ) name: Optional[str] = Field( None, description='Required. The client-assigned metric identifier. Examples: "error_count", "nginx/requests".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*\',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.This field is the [METRIC_ID] part of a metric resource name in the format "projects/PROJECT_ID/metrics/METRIC_ID". Example: If the resource name of a metric is "projects/my-project/metrics/nginx%2Frequests", this field\'s value is "nginx/requests".', ) updateTime: Optional[str] = Field( None, description='Output only. The last update timestamp of the metric.This field may not be present for older metrics.', ) valueExtractor: Optional[str] = Field( None, description='Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The arguments are: field: The name of the log entry field from which the value is to be extracted. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, ".*quantity=(\\d+).*")', ) version: Optional[Version] = Field( None, description='Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.', ) class ListLogMetricsResponse(BaseModel): metrics: Optional[List[LogMetric]] = Field( None, description='A list of logs-based metrics.' ) nextPageToken: Optional[str] = Field( None, description='If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.', )