@maxim_mazurok/gapi.client.logging-v2 0.0.20231210 → 0.0.20240108

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://logging.googleapis.com/$discovery/rest?version=v2
-// Revision: 20231210
+// Revision: 20240108
 
 /// <reference types="gapi.client" />
 
@@ -41,7 +41,7 @@ declare namespace gapi.client {
       endTime?: string;
       /** The create time of an operation. */
       startTime?: string;
-      /** State of an operation. */
+      /** Output only. State of an operation. */
       state?: string;
       /** LongRunningUpdateBucket RPC request. */
       updateBucketRequest?: UpdateBucketRequest;
@@ -56,9 +56,9 @@ declare namespace gapi.client {
     }
     interface CancelOperationRequest {}
     interface CmekSettings {
-      /** 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 needed 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. */
+      /** 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 needed 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. */
       kmsKeyName?: string;
-      /** 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. */
+      /** Output only. 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. */
       kmsKeyVersionName?: string;
       /** Output only. The resource name of the CMEK settings. */
       name?: string;
@@ -76,7 +76,7 @@ declare namespace gapi.client {
       request?: CopyLogEntriesRequest;
       /** The create time of an operation. */
       startTime?: string;
-      /** State of an operation. */
+      /** Output only. State of an operation. */
       state?: string;
       /** 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" */
       writerIdentity?: string;
@@ -191,15 +191,15 @@ declare namespace gapi.client {
       width?: number;
     }
     interface Link {
-      /** 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. */
+      /** Optional. 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. */
       bigqueryDataset?: BigQueryDataset;
       /** Output only. The creation timestamp of the link. */
       createTime?: string;
-      /** Describes this link.The maximum length of the description is 8000 characters. */
+      /** Optional. Describes this link.The maximum length of the description is 8000 characters. */
       description?: string;
       /** Output only. The resource lifecycle state. */
       lifecycleState?: string;
-      /** 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 */
+      /** Output only. 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 */
       name?: string;
     }
     interface LinkMetadata {
@@ -211,7 +211,7 @@ declare namespace gapi.client {
       endTime?: string;
       /** The start time of an operation. */
       startTime?: string;
-      /** State of an operation. */
+      /** Output only. State of an operation. */
       state?: string;
     }
     interface ListBucketsResponse {
@@ -327,25 +327,25 @@ declare namespace gapi.client {
       logAnalyticsEnabled?: boolean;
     }
     interface LogBucket {
-      /** Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. */
+      /** Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. */
       analyticsEnabled?: boolean;
-      /** 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. */
+      /** Optional. 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. */
       cmekSettings?: CmekSettings;
       /** Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. */
       createTime?: string;
-      /** Describes this bucket. */
+      /** Optional. Describes this bucket. */
       description?: string;
-      /** A list of indexed fields and related configuration data. */
+      /** Optional. A list of indexed fields and related configuration data. */
       indexConfigs?: IndexConfig[];
       /** Output only. The bucket lifecycle state. */
       lifecycleState?: string;
-      /** 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. */
+      /** Optional. 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. */
       locked?: boolean;
       /** 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. */
       name?: string;
-      /** 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) */
+      /** Optional. 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) */
       restrictedFields?: string[];
-      /** 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. */
+      /** Optional. 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. */
       retentionDays?: number;
       /** Output only. The last update timestamp of the bucket. */
       updateTime?: string;
@@ -421,17 +421,17 @@ declare namespace gapi.client {
       disabled?: boolean;
       /** 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) */
       filter?: string;
-      /** 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. */
+      /** Output only. 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. */
       name?: string;
       /** Output only. The last update timestamp of the exclusion.This field may not be present for older exclusions. */
       updateTime?: string;
     }
     interface LoggingQuery {
-      /** An advanced query using the Logging Query Language (https://cloud.google.com/logging/docs/view/logging-query-language). The maximum length of the filter is 20000 characters. */
+      /** Required. An advanced query using the Logging Query Language (https://cloud.google.com/logging/docs/view/logging-query-language). The maximum length of the filter is 20000 characters. */
       filter?: string;
       /** Characters will be counted from the end of the string. */
       summaryFieldEnd?: number;
-      /** The set of summary fields to display for this saved query. */
+      /** Optional. The set of summary fields to display for this saved query. */
       summaryFields?: SummaryField[];
       /** Characters will be counted from the start of the string. */
       summaryFieldStart?: number;
@@ -489,7 +489,7 @@ declare namespace gapi.client {
       filter?: string;
       /** 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 */
       includeChildren?: boolean;
-      /** 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, periods.First character has to be alphanumeric. */
+      /** Output only. 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, periods.First character has to be alphanumeric. */
       name?: string;
       /** Deprecated. This field is unused. */
       outputVersionFormat?: string;
@@ -509,11 +509,11 @@ declare namespace gapi.client {
     interface LogView {
       /** Output only. The creation timestamp of the view. */
       createTime?: string;
-      /** Describes this view. */
+      /** Optional. Describes this view. */
       description?: string;
-      /** Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND NOT LOG_ID("stdout") */
+      /** Optional. Filter that restricts which log entries in a bucket are visible in this view.Filters must be logical conjunctions that use the AND operator, and they can use any of the following qualifiers: SOURCE(), which specifies a project, folder, organization, or billing account of origin. resource.type, which specifies the resource type. LOG_ID(), which identifies the log.They can also use the negations of these qualifiers with the NOT operator.For example:SOURCE("projects/myproject") AND resource.type = "gce_instance" AND NOT LOG_ID("stdout") */
       filter?: string;
-      /** The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view */
+      /** Output only. The resource name of the view.For example:projects/my-project/locations/global/buckets/my-bucket/views/my-view */
       name?: string;
       /** Output only. The last update timestamp of the view. */
       updateTime?: string;
@@ -567,7 +567,7 @@ declare namespace gapi.client {
       launchStage?: string;
       /** 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}". */
       name?: string;
-      /** 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). */
+      /** Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitored resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). */
       type?: string;
     }
     interface MonitoredResourceMetadata {
@@ -593,7 +593,7 @@ declare namespace gapi.client {
       sqlQueryText?: string;
     }
     interface RecentQuery {
-      /** The timestamp when this query was last run. */
+      /** Output only. The timestamp when this query was last run. */
       lastRunTime?: string;
       /** Logging query that can be executed in Logs Explorer or via Logging API. */
       loggingQuery?: LoggingQuery;
@@ -675,9 +675,9 @@ declare namespace gapi.client {
     interface SavedQuery {
       /** Output only. The timestamp when the saved query was created. */
       createTime?: string;
-      /** A human readable description of the saved query. */
+      /** Optional. A human readable description of the saved query. */
       description?: string;
-      /** The user specified title for the SavedQuery. */
+      /** Optional. The user specified title for the SavedQuery. */
       displayName?: string;
       /** Logging query that can be executed in Logs Explorer or via Logging API. */
       loggingQuery?: LoggingQuery;
@@ -727,7 +727,7 @@ declare namespace gapi.client {
       message?: string;
     }
     interface SummaryField {
-      /** The field from the LogEntry to include in the summary line, for example resource.type or jsonPayload.name. */
+      /** Optional. The field from the LogEntry to include in the summary line, for example resource.type or jsonPayload.name. */
       field?: string;
     }
     interface SuppressionInfo {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.logging-v2",
-  "version": "0.0.20231210",
+  "version": "0.0.20240108",
   "description": "TypeScript typings for Cloud Logging API v2",
   "repository": {
     "type": "git",