"""Generated message classes for logging version v2. Writes log entries and manages your Cloud Logging configuration. """ # NOTE: This file is autogenerated and should not be edited by hand. from __future__ import absolute_import from apitools.base.protorpclite import messages as _messages from apitools.base.py import encoding from apitools.base.py import extra_types package = 'logging' class AggregateValueThreshold(_messages.Message): r"""A threshold condition that compares an aggregation to a threshold. Fields: aggregateColumn: Required. The column to provide aggregation on for comparison. aggregation: Required. The aggregation config that will be applied to the provided column. """ aggregateColumn = _messages.StringField(1) aggregation = _messages.MessageField('QueryStepAggregation', 2) class AlertingBooleanTest(_messages.Message): r"""A test that reads a boolean column as the result. Fields: booleanColumn: Required. The column that contains a boolean that we want to use as our result. trigger: Optional. The number/percent of rows that must match in order for the result set (partition set) to be considered in violation. If unspecified, then the result set (partition set) will be in violation if a single row matches.NOTE: Triggers are not yet supported for BooleanTest. """ booleanColumn = _messages.StringField(1) trigger = _messages.MessageField('AlertingTrigger', 2) class AlertingQueryStep(_messages.Message): r"""A query step defined as a set of alerting configuration options. This may not be used as the first step in a query. Fields: booleanCondition: A test representing the boolean value of a column. partitionColumns: Optional. The list of columns to GROUP BY in the generated SQL. NOTE: partition columns are not yet supported. stringCondition: A test representing a comparison against a string. thresholdCondition: A test representing a comparison against a threshold. """ booleanCondition = _messages.MessageField('AlertingBooleanTest', 1) partitionColumns = _messages.StringField(2, repeated=True) stringCondition = _messages.MessageField('AlertingStringTest', 3) thresholdCondition = _messages.MessageField('AlertingThresholdTest', 4) class AlertingStringTest(_messages.Message): r"""A test that compares a string column against a string to match. NOTE: StringTest is not yet supported. Enums: ComparisonValueValuesEnum: Required. The comparison operator to use. Fields: column: Required. The column that contains the strings we want to search on. comparison: Required. The comparison operator to use. pattern: Required. The string or regular expression which is compared to the value in the column. trigger: Optional. The number/percent of rows that must match in order for the result set (partition set) to be considered in violation. If unspecified, then the result set (partition set) will be in violation if a single row matches. """ class ComparisonValueValuesEnum(_messages.Enum): r"""Required. The comparison operator to use. Values: STRING_COMPARISON_TYPE_UNSPECIFIED: No string comparison specified, should never happen. STRING_COMPARISON_MATCH: String column must equal the pattern. STRING_COMPARISON_NOT_MATCH: String column must not equal the pattern. STRING_COMPARISON_CONTAINS: String contains contains the pattern as a substring. STRING_COMPARISON_NOT_CONTAINS: String column does not contain the pattern as a substring. STRING_COMPARISON_REGEX_MATCH: Regular expression pattern found in string column. STRING_COMPARISON_REGEX_NOT_MATCH: Regular expression pattern not found in string column. """ STRING_COMPARISON_TYPE_UNSPECIFIED = 0 STRING_COMPARISON_MATCH = 1 STRING_COMPARISON_NOT_MATCH = 2 STRING_COMPARISON_CONTAINS = 3 STRING_COMPARISON_NOT_CONTAINS = 4 STRING_COMPARISON_REGEX_MATCH = 5 STRING_COMPARISON_REGEX_NOT_MATCH = 6 column = _messages.StringField(1) comparison = _messages.EnumField('ComparisonValueValuesEnum', 2) pattern = _messages.StringField(3) trigger = _messages.MessageField('AlertingTrigger', 4) class AlertingThresholdTest(_messages.Message): r"""A test that compares some LHS against a threshold. NOTE: Only RowCountThreshold is currently supported. Enums: ComparisonValueValuesEnum: Required. The comparison to be applied in the __alert_result condition. Fields: aggregateValueThreshold: A value threshold comparison that includes an aggregation of the value column. comparison: Required. The comparison to be applied in the __alert_result condition. rowCountThreshold: A threshold based on the number of rows present. threshold: Required. The threshold that will be used as the RHS of a comparison. valueThreshold: A value threshold comparison. """ class ComparisonValueValuesEnum(_messages.Enum): r"""Required. The comparison to be applied in the __alert_result condition. Values: COMPARISON_TYPE_UNSPECIFIED: No comparison relationship is specified. COMPARISON_GT: True if the aggregate / value_column is greater than the threshold. COMPARISON_GE: True if the aggregate / value_column is greater than or equal to the threshold. COMPARISON_LT: True if the aggregate / value_column is less than the threshold. COMPARISON_LE: True if the aggregate / value_column is less than or equal to the threshold. COMPARISON_EQ: True if the aggregate / value_column is equal to the threshold. COMPARISON_NE: True if the aggregate / value_column is not equal to the threshold. """ COMPARISON_TYPE_UNSPECIFIED = 0 COMPARISON_GT = 1 COMPARISON_GE = 2 COMPARISON_LT = 3 COMPARISON_LE = 4 COMPARISON_EQ = 5 COMPARISON_NE = 6 aggregateValueThreshold = _messages.MessageField('AggregateValueThreshold', 1) comparison = _messages.EnumField('ComparisonValueValuesEnum', 2) rowCountThreshold = _messages.MessageField('RowCountThreshold', 3) threshold = _messages.FloatField(4) valueThreshold = _messages.MessageField('ValueThreshold', 5) class AlertingTrigger(_messages.Message): r"""A restriction on the alert test to require a certain count or percent of rows to be present. Fields: count: Optional. The absolute number of time series that must fail the predicate for the test to be triggered. percent: Optional. The percentage of time series that must fail the predicate for the test to be triggered. """ count = _messages.IntegerField(1, variant=_messages.Variant.INT32) percent = _messages.FloatField(2) class AnalyticsQuery(_messages.Message): r"""The configuration of a query to be run by QueryData or QueryDataLocal, or validated by ValidateQuery or ValidateQueryLocal. Fields: querySteps: Required. The query steps to execute. Each query step will correspond to a handle in the result proto. """ querySteps = _messages.MessageField('QueryStep', 1, repeated=True) class AppHub(_messages.Message): r"""Metadata associated with App Hub. Fields: application: Metadata associated with the application. service: Metadata associated with the service. workload: Metadata associated with the workload. """ application = _messages.MessageField('AppHubApplication', 1) service = _messages.MessageField('AppHubService', 2) workload = _messages.MessageField('AppHubWorkload', 3) class AppHubApplication(_messages.Message): r"""Resource identifiers associated with an AppHub application AppHub resources are of the form projects//locations//applications/ projects//locations//applications//services/ projects//locations//applications//workloads/ These resources can be reconstructed from the components below. Fields: container: Resource container that owns the application. Example: "projects/management_project" id: Application Id. Example: "my-app" location: Location associated with the Application. Example: "us-east1" """ container = _messages.StringField(1) id = _messages.StringField(2) location = _messages.StringField(3) class AppHubService(_messages.Message): r"""Metadata associated with an App Hub service. Fields: criticalityType: Service criticality type Example: "CRITICAL" environmentType: Service environment type Example: "DEV" id: Service Id. Example: "my-service" """ criticalityType = _messages.StringField(1) environmentType = _messages.StringField(2) id = _messages.StringField(3) class AppHubWorkload(_messages.Message): r"""Metadata associated with an App Hub workload. Fields: criticalityType: Workload criticality type Example: "CRITICAL" environmentType: Workload environment type Example: "DEV" id: Workload Id. Example: "my-workload" """ criticalityType = _messages.StringField(1) environmentType = _messages.StringField(2) id = _messages.StringField(3) class ApproveRedactionOperationResponse(_messages.Message): r"""Response type for ApproveRedaction method.""" class BigQueryDataset(_messages.Message): r"""Describes a BigQuery dataset that was created by a link. Fields: datasetId: 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" """ datasetId = _messages.StringField(1) class BigQueryOptions(_messages.Message): r"""Options that change functionality of a sink exporting data to BigQuery. Fields: usePartitionedTables: 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: Output only. True if new timestamp column based partitioning is in use, false if legacy ingress-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. """ usePartitionedTables = _messages.BooleanField(1) usesTimestampColumnPartitioning = _messages.BooleanField(2) class Binding(_messages.Message): r"""Associates members, or principals, with a role. Fields: condition: The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). members: Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other- app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes- service-accounts). For example, my-project.svc.id.goog[my-namespace/my- kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locat ions/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googl eapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/l ocations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{att ribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_ id}/*: All identities in a workforce identity pool. principal://iam.goog leapis.com/projects/{project_number}/locations/global/workloadIdentityPo ols/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{proj ect_number}/locations/global/workloadIdentityPools/{pool_id}/group/{grou p_id}: A workload identity pool group. principalSet://iam.googleapis.com /projects/{project_number}/locations/global/workloadIdentityPools/{pool_ id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.goog leapis.com/projects/{project_number}/locations/global/workloadIdentityPo ols/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other- app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/location s/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, delet ed:principal://iam.googleapis.com/locations/global/workforcePools/my- pool-id/subject/my-subject-attribute-value. role: Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles). """ condition = _messages.MessageField('Expr', 1) members = _messages.StringField(2, repeated=True) role = _messages.StringField(3) class BucketMetadata(_messages.Message): r"""Metadata for LongRunningUpdateBucket Operations. Enums: StateValueValuesEnum: Output only. State of an operation. Fields: createBucketRequest: LongRunningCreateBucket RPC request. endTime: The end time of an operation. startTime: The create time of an operation. state: Output only. State of an operation. updateBucketRequest: LongRunningUpdateBucket RPC request. """ class StateValueValuesEnum(_messages.Enum): r"""Output only. State of an operation. Values: OPERATION_STATE_UNSPECIFIED: Should not be used. OPERATION_STATE_SCHEDULED: The operation is scheduled. OPERATION_STATE_WAITING_FOR_PERMISSIONS: Waiting for necessary permissions. OPERATION_STATE_RUNNING: The operation is running. OPERATION_STATE_SUCCEEDED: The operation was completed successfully. OPERATION_STATE_FAILED: The operation failed. OPERATION_STATE_CANCELLED: The operation was cancelled by the user. OPERATION_STATE_PENDING: The operation is waiting for quota. """ OPERATION_STATE_UNSPECIFIED = 0 OPERATION_STATE_SCHEDULED = 1 OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2 OPERATION_STATE_RUNNING = 3 OPERATION_STATE_SUCCEEDED = 4 OPERATION_STATE_FAILED = 5 OPERATION_STATE_CANCELLED = 6 OPERATION_STATE_PENDING = 7 createBucketRequest = _messages.MessageField('CreateBucketRequest', 1) endTime = _messages.StringField(2) startTime = _messages.StringField(3) state = _messages.EnumField('StateValueValuesEnum', 4) updateBucketRequest = _messages.MessageField('UpdateBucketRequest', 5) class BucketOptions(_messages.Message): r"""BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i > 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite. Fields: explicitBuckets: The explicit buckets. exponentialBuckets: The exponential buckets. linearBuckets: The linear bucket. """ explicitBuckets = _messages.MessageField('Explicit', 1) exponentialBuckets = _messages.MessageField('Exponential', 2) linearBuckets = _messages.MessageField('Linear', 3) class CancelOperationRequest(_messages.Message): r"""The request message for Operations.CancelOperation.""" class CancelQueryRequest(_messages.Message): r"""The request message for CancelQuery. Fields: queryStepHandle: Required. A query step handle returned by QueryData. All steps in the query will be cancelled. resourceNames: Required. Names of one or more views that were used in the original query.Example: projects/[PROJECT_ID]/locations/[LOCATION_ID]/bu ckets/[BUCKET_ID]/views/[VIEW_ID]Requires appropriate permissions on each resource such as 'logging.views.access' on log view resources. """ queryStepHandle = _messages.StringField(1) resourceNames = _messages.StringField(2, repeated=True) class CancelQueryResponse(_messages.Message): r"""The response data from CancelQuery.""" class ChartingBreakdown(_messages.Message): r"""Columns within the output of the previous step to use to break down the measures. We will generate one output measure for each value in the cross product of measure_columns plus the top limit values in each of the breakdown columns.In other words, if there is one measure column "foo" and two breakdown columns "bar" with values ("bar1","bar2") and "baz" with values ("baz1", "baz2"), we will end up with four output measures with names: foo_bar1_baz1, foo_bar1_baz2, foo_bar2_baz1, foo_bar2_baz2 Each of these measures will contain a subset of the values in "foo". Enums: SortOrderValueValuesEnum: Optional. The ordering that defines the behavior of limit. If limit is not zero, this may not be set to SORT_ORDER_NONE.Note that this will not control the ordering of the rows in the result table in any useful way. Use the top-level sort ordering for that purpose. Fields: column: Required. The name of the column containing the breakdown values. limit: Optional. Values to choose how many breakdowns to create for each measure. If limit is zero, all possible breakdowns will be generated. If not, limit determines how many breakdowns, and sort_aggregation determines the function we will use to sort the breakdowns.For example, if limit is 3, we will generate at most three breakdowns per measure. If sort_aggregation is "average" and sort_order is DESCENDING, those three will be chosen as the ones where the average of all the points in the breakdown set is the greatest. sortAggregation: Optional. The aggregation to apply to the measure values when choosing which breakdowns to generate. If sort_order is SORT_ORDER_NONE, this is not used. sortOrder: Optional. The ordering that defines the behavior of limit. If limit is not zero, this may not be set to SORT_ORDER_NONE.Note that this will not control the ordering of the rows in the result table in any useful way. Use the top-level sort ordering for that purpose. """ class SortOrderValueValuesEnum(_messages.Enum): r"""Optional. The ordering that defines the behavior of limit. If limit is not zero, this may not be set to SORT_ORDER_NONE.Note that this will not control the ordering of the rows in the result table in any useful way. Use the top-level sort ordering for that purpose. Values: SORT_ORDER_UNSPECIFIED: Invalid value, do not use. SORT_ORDER_NONE: No sorting will be applied. SORT_ORDER_ASCENDING: The lowest-valued entries will be selected. SORT_ORDER_DESCENDING: The highest-valued entries will be selected. """ SORT_ORDER_UNSPECIFIED = 0 SORT_ORDER_NONE = 1 SORT_ORDER_ASCENDING = 2 SORT_ORDER_DESCENDING = 3 column = _messages.StringField(1) limit = _messages.IntegerField(2, variant=_messages.Variant.INT32) sortAggregation = _messages.MessageField('QueryStepAggregation', 3) sortOrder = _messages.EnumField('SortOrderValueValuesEnum', 4) class ChartingDimension(_messages.Message): r"""A definition for the (one) dimension column in the output. Multiple dimensions can be defined, but only a single column will be generated, containing the cross-product of the defined dimensions. Fields: column: Required. The column name within the output of the previous step to use. columnType: Optional. The type of the dimension column. This is relevant only if one of the bin_size fields is set. If it is empty, the type TIMESTAMP or INT64 will be assumed based on which bin_size field is set. If populated, this should be set to one of the following types: DATE, TIME, DATETIME, TIMESTAMP, BIGNUMERIC, INT64, NUMERIC, FLOAT64. We also accept all the documented aliases from https://cloud.google.com/bigquery/docs/reference/standard-sql/data- types#numeric_types as well as FLOAT (as an alias for FLOAT64). floatBinSize: Optional. Used for a floating-point column: FLOAT64. integerBinSize: Optional. Used for an integer column: INT64, NUMERIC, or BIGNUMERIC. limit: Optional. If set, any bins beyond this number will be dropped. limitPlusOther: Optional. If set, up to this many bins will be generated plus one optional additional bin. The extra bin will be named "Other" and will contain the sum of the (aggregated) measure points from all remaining bins. Setting this field will cause the dimension column type to be coerced to STRING if it is not already that type. sorting: Optional. The sorting for the dimension that defines the behavior of limit. If limit is not zero, this may not be set to SORT_ORDER_NONE.The column may be set to this dimension column or any measure column. If the field is empty, it will sort on the dimension column. If there is an anonymous measure using aggregation "count", use the string "*" to name it here.Note that this will not control the ordering of the rows in the result table in any useful way. Use the top- level sort ordering for that purpose. timeBinSize: Optional. Used for a time or date column: DATE, TIME, DATETIME, or TIMESTAMP. If column_type is DATE, this must be a multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours. """ column = _messages.StringField(1) columnType = _messages.StringField(2) floatBinSize = _messages.FloatField(3) integerBinSize = _messages.IntegerField(4) limit = _messages.IntegerField(5, variant=_messages.Variant.INT32) limitPlusOther = _messages.IntegerField(6, variant=_messages.Variant.INT32) sorting = _messages.MessageField('Sorting', 7) timeBinSize = _messages.StringField(8) class ChartingMeasure(_messages.Message): r"""A definition for a single measure column in the output table. Multiple measure columns will produce multiple curves, stacked bars, etc. depending on chart type. Fields: aggregation: Optional. The aggregation to apply to the input column. Required if binning is enabled on the dimension. column: Required. The column name within the output of the previous step to use. May be the same column as the dimension. May be left empty if the aggregation is set to "count" (but not "count-distinct" or "count- distinct-approx"). """ aggregation = _messages.MessageField('QueryStepAggregation', 1) column = _messages.StringField(2) class ChartingQueryStep(_messages.Message): r"""A query step defined as a set of charting configuration options. This may not be used as the first step in a query. Fields: breakdowns: Optional. The breakdowns for the measures of the chart. A breakdown turns a single measure into multiple effective measures, each one associated with a single value from the breakdown column. dimensions: Required. The dimension columns. How many dimensions to choose and how they're configured will depend on the chart type. A dimension is the labels for the data; e.g., the X axis for a line graph or the segment labels for a pie chart. measures: Required. The measures to be displayed within the chart. A measure is a data set to be displayed; e.g., a line on a line graph, a set of bars on a bar graph, or the segment widths on a pie chart. sorting: Optional. The top-level sorting that determines the order in which the results are returned.The column may be set to one of the dimension columns or left empty, which is equivalent. If no breakdowns are requested, it may be set to any measure column; if breakdowns are requested, sorting by measures is not supported. If there is an anonymous measure using aggregation "count", use the string "*" to name it here. """ breakdowns = _messages.MessageField('ChartingBreakdown', 1, repeated=True) dimensions = _messages.MessageField('ChartingDimension', 2, repeated=True) measures = _messages.MessageField('ChartingMeasure', 3, repeated=True) sorting = _messages.MessageField('Sorting', 4) class CmekSettings(_messages.Message): r"""Describes the customer-managed encryption key (CMEK) settings associated with a project, folder, organization, billing account, or flexible resource.Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization.See Enabling CMEK for Log Router (https://cloud.google.com/logging/docs/routing/managed-encryption) for more information. Fields: kmsKeyName: Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/key Rings/[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. kmsKeyVersionName: Output only. The CryptoKeyVersion resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/loc ations/[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: Output only. The resource name of the CMEK settings. serviceAccountId: 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. """ kmsKeyName = _messages.StringField(1) kmsKeyVersionName = _messages.StringField(2) name = _messages.StringField(3) serviceAccountId = _messages.StringField(4) class CopyLogEntriesMetadata(_messages.Message): r"""Metadata for CopyLogEntries long running operations. Enums: StateValueValuesEnum: Output only. State of an operation. Fields: cancellationRequested: Identifies whether the user has requested cancellation of the operation. destination: Destination to which to copy log entries.For example, a Cloud Storage bucket:"storage.googleapis.com/my-cloud-storage-bucket" endTime: The end time of an operation. progress: Estimated progress of the operation (0 - 100%). request: CopyLogEntries RPC request. This field is deprecated and not used. source: Source from which to copy log entries.For example, a log bucket:"projects/my-project/locations/global/buckets/my-source-bucket" startTime: The create time of an operation. state: Output only. State of an operation. verb: Name of the verb executed by the operation.For example,"copy" writerIdentity: 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 StateValueValuesEnum(_messages.Enum): r"""Output only. State of an operation. Values: OPERATION_STATE_UNSPECIFIED: Should not be used. OPERATION_STATE_SCHEDULED: The operation is scheduled. OPERATION_STATE_WAITING_FOR_PERMISSIONS: Waiting for necessary permissions. OPERATION_STATE_RUNNING: The operation is running. OPERATION_STATE_SUCCEEDED: The operation was completed successfully. OPERATION_STATE_FAILED: The operation failed. OPERATION_STATE_CANCELLED: The operation was cancelled by the user. OPERATION_STATE_PENDING: The operation is waiting for quota. """ OPERATION_STATE_UNSPECIFIED = 0 OPERATION_STATE_SCHEDULED = 1 OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2 OPERATION_STATE_RUNNING = 3 OPERATION_STATE_SUCCEEDED = 4 OPERATION_STATE_FAILED = 5 OPERATION_STATE_CANCELLED = 6 OPERATION_STATE_PENDING = 7 cancellationRequested = _messages.BooleanField(1) destination = _messages.StringField(2) endTime = _messages.StringField(3) progress = _messages.IntegerField(4, variant=_messages.Variant.INT32) request = _messages.MessageField('CopyLogEntriesRequest', 5) source = _messages.StringField(6) startTime = _messages.StringField(7) state = _messages.EnumField('StateValueValuesEnum', 8) verb = _messages.StringField(9) writerIdentity = _messages.StringField(10) class CopyLogEntriesRequest(_messages.Message): r"""The parameters to CopyLogEntries. Fields: destination: Required. Destination to which to copy log entries. For example: "storage.googleapis.com/GCS_BUCKET" filter: 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: Required. Log bucket from which to copy log entries.For example:"projects/my-project/locations/global/buckets/my-source-bucket" """ destination = _messages.StringField(1) filter = _messages.StringField(2) name = _messages.StringField(3) class CopyLogEntriesResponse(_messages.Message): r"""Response type for CopyLogEntries long running operations. Fields: logEntriesCopiedCount: Number of log entries copied. """ logEntriesCopiedCount = _messages.IntegerField(1) class CreateBucketRequest(_messages.Message): r"""The parameters to CreateBucket. Fields: bucket: 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: 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. Bucket identifiers must start with an alphanumeric character. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucket = _messages.MessageField('LogBucket', 1) bucketId = _messages.StringField(2) parent = _messages.StringField(3) class CreateLinkRequest(_messages.Message): r"""The parameters to CreateLink. Fields: link: Required. The new link. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3) class DefaultSinkConfig(_messages.Message): r"""Describes the custom _Default sink configuration that is used to override the built-in _Default sink configuration in newly created resource containers, such as projects or folders. Enums: ModeValueValuesEnum: Required. Determines the behavior to apply to the built-in _Default sink inclusion filter.Exclusions are always appended, as built-in _Default sinks have no exclusions. Fields: exclusions: Optional. Specifies the set of exclusions to be added to the _Default sink in newly created resource containers. filter: 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>=ERRORTo match all logs, don't add exclusions and use the following line as the value of filter:logName:*Cannot be empty or unset when the value of mode is OVERWRITE. mode: Required. Determines the behavior to apply to the built-in _Default sink inclusion filter.Exclusions are always appended, as built-in _Default sinks have no exclusions. """ class ModeValueValuesEnum(_messages.Enum): r"""Required. Determines the behavior to apply to the built-in _Default sink inclusion filter.Exclusions are always appended, as built-in _Default sinks have no exclusions. Values: FILTER_WRITE_MODE_UNSPECIFIED: The filter's write mode is unspecified. This mode must not be used. APPEND: The contents of filter will be appended to the built-in _Default sink filter. Using the append mode with an empty filter will keep the sink inclusion filter unchanged. OVERWRITE: The contents of filter will overwrite the built-in _Default sink filter. """ FILTER_WRITE_MODE_UNSPECIFIED = 0 APPEND = 1 OVERWRITE = 2 exclusions = _messages.MessageField('LogExclusion', 1, repeated=True) filter = _messages.StringField(2) mode = _messages.EnumField('ModeValueValuesEnum', 3) class DeleteLinkRequest(_messages.Message): r"""The parameters to DeleteLink. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1) class Empty(_messages.Message): r"""A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } """ class Explicit(_messages.Message): r"""Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): boundsi Lower bound (1 <= i < N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets. Fields: bounds: The values must be monotonically increasing. """ bounds = _messages.FloatField(1, repeated=True) class Exponential(_messages.Message): r"""Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).Lower bound (1 <= i < N): scale * (growth_factor ^ (i - 1)). Fields: growthFactor: Must be greater than 1. numFiniteBuckets: Must be greater than 0. scale: Must be greater than 0. """ growthFactor = _messages.FloatField(1) numFiniteBuckets = _messages.IntegerField(2, variant=_messages.Variant.INT32) scale = _messages.FloatField(3) class Expr(_messages.Message): r"""Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. Fields: description: Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. expression: Textual representation of an expression in Common Expression Language syntax. location: Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. title: Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. """ description = _messages.StringField(1) expression = _messages.StringField(2) location = _messages.StringField(3) title = _messages.StringField(4) class FieldSource(_messages.Message): r"""LINT.IfChange A source that can be used to represent a field in a query construct. Fields: aliasRef: The alias name for a field that has already been aliased within a different ProjectedField type elsewhere in the query model. The alias must be defined in the QueryBuilderConfig's field_sources list, otherwise the model is invalid. columnType: The type of the selected field. This comes from the schema. Can be one of the BigQuery data types: - STRING - INT64 - FLOAT64 - BOOL - TIMESTAMP - DATE - RECORD - JSON field: This will be the field that is selected using the . annotation to display the drill down value. For example: "json_payload.labels.message". isJson: Whether the field is a JSON field, or has a parent that is a JSON field. This value is used to determine JSON extractions in generated SQL queries. Note that this is_json flag may be true when the column_type is not JSON if the parent is a JSON field. Ex: - A json_payload.message field might have is_json=true, since the 'json_payload' parent is of type JSON, and columnType='STRING' if the 'message' field is of type STRING. literalValue: A literal like "1,2,3 as testArray" or other singular constants like 'foo'. Note: this is not a viable option for the order_by since sorting based on a constant doesn't return anything useful. projectedField: A projected field option for when a user wants to use a field with some additional transformations such as casting or extractions. variableRef: The variable name for dashboard template variable support. """ aliasRef = _messages.StringField(1) columnType = _messages.StringField(2) field = _messages.StringField(3) isJson = _messages.BooleanField(4) literalValue = _messages.MessageField('extra_types.JsonValue', 5) projectedField = _messages.MessageField('ProjectedField', 6) variableRef = _messages.StringField(7) class FilterExpression(_messages.Message): r"""This is a leaf of the FilterPredicate. Ex: { field: json_payload.message.error_code, filter_value: {numeric_value: 400}, comparator: EQUAL_TO} The field will be schema field that is selected using the . annotation to display the drill down value. The value will be the user inputted text that the filter is comparing against. Enums: ComparatorValueValuesEnum: The comparison type to use for the filter. Fields: booleanFilterValue: The boolean value to use for the filter. Set if the field is a boolean type. comparator: The comparison type to use for the filter. field: A string attribute. fieldSource: Can be one of the FieldSource types: field name, alias ref, variable ref, or a literal value. fieldSourceValue: The field. This will be the field that is set as the Right Hand Side of the filter. isNegation: Determines if the NOT flag should be added to the comparator. literalValue: The Value will be used to hold user defined constants set as the Right Hand Side of the filter. numericFilterValue: The numeric value to use for the filter. Set if the field is a numeric type. stringFilterValue: The string value to use for the filter. Set if the field is a string type. """ class ComparatorValueValuesEnum(_messages.Enum): r"""The comparison type to use for the filter. Values: COMPARATOR_UNSPECIFIED: Invalid value, do not use. EQUALS: The value is equal to the inputted value. NOT_EQUALS: The value is not equal to the inputted value. MATCHES_REGEXP: The value is equal to the inputted regex value. NOT_MATCHES_REGEXP: The value is not equal to the inputted regex value. GREATER_THAN: The value is greater than the inputted value. LESS_THAN: The value is less than the inputted value. GREATER_THAN_EQUALS: The value is greater than or equal to the inputted value. LESS_THAN_EQUALS: The value is less than or equal to the inputted value. IS_NOT_NULL: IS_NOT_NULL will be slightly different in the fact that it will not require the value field to be inputted. For simplicity, the value field will be set to an empty string when IS_NOT_NULL is used IS_NULL: Requires the filter_value to be a Value type with null_value set to true. IN: The value is in the inputted array value. LIKE: The value is like the inputted value. """ COMPARATOR_UNSPECIFIED = 0 EQUALS = 1 NOT_EQUALS = 2 MATCHES_REGEXP = 3 NOT_MATCHES_REGEXP = 4 GREATER_THAN = 5 LESS_THAN = 6 GREATER_THAN_EQUALS = 7 LESS_THAN_EQUALS = 8 IS_NOT_NULL = 9 IS_NULL = 10 IN = 11 LIKE = 12 booleanFilterValue = _messages.BooleanField(1) comparator = _messages.EnumField('ComparatorValueValuesEnum', 2) field = _messages.StringField(3) fieldSource = _messages.MessageField('FieldSource', 4) fieldSourceValue = _messages.MessageField('FieldSource', 5) isNegation = _messages.BooleanField(6) literalValue = _messages.MessageField('extra_types.JsonValue', 7) numericFilterValue = _messages.FloatField(8, variant=_messages.Variant.FLOAT) stringFilterValue = _messages.StringField(9) class FilterPredicate(_messages.Message): r"""A filter for a query. This equates to the WHERE clause in SQL. Enums: OperatorTypeValueValuesEnum: The operator type for the filter. Currently there is no support for multiple levels of nesting, so this will be a single value with no joining of different operator types Fields: childPredicates: The children of the filter predicate. This equates to the branches of the filter predicate that could contain further nested leaves. expressions: The expressions to use for the filter. leafPredicate: The leaves of the filter predicate. This equates to the last leaves of the filter predicate associated with an operator. operatorType: The operator type for the filter. Currently there is no support for multiple levels of nesting, so this will be a single value with no joining of different operator types """ class OperatorTypeValueValuesEnum(_messages.Enum): r"""The operator type for the filter. Currently there is no support for multiple levels of nesting, so this will be a single value with no joining of different operator types Values: OPERATOR_TYPE_UNSPECIFIED: Invalid value, do not use. AND: AND will be the default operator type. OR: OR operator type. LEAF: LEAF operator type. """ OPERATOR_TYPE_UNSPECIFIED = 0 AND = 1 OR = 2 LEAF = 3 childPredicates = _messages.MessageField('FilterPredicate', 1, repeated=True) expressions = _messages.MessageField('FilterExpression', 2, repeated=True) leafPredicate = _messages.MessageField('FilterExpression', 3) operatorType = _messages.EnumField('OperatorTypeValueValuesEnum', 4) class FunctionApplication(_messages.Message): r"""Defines the aggregation function to apply to this field. This message is used only when operation is set to AGGREGATE. Fields: parameters: Optional. Parameters to be applied to the aggregation. Aggregations that support or require parameters are listed above. type: Required. Specifies the aggregation function. Use one of the following string identifiers: "average": Computes the average (AVG). Applies only to numeric values. "count": Counts the number of values (COUNT). "count-distinct": Counts the number of distinct values (COUNT DISTINCT). "count-distinct-approx": Approximates the count of distinct values (APPROX_COUNT_DISTINCT). "max": Finds the maximum value (MAX). Applies only to numeric values. "min": Finds the minimum value (MIN). Applies only to numeric values. "sum": Computes the sum (SUM). Applies only to numeric values. """ parameters = _messages.MessageField('extra_types.JsonValue', 1, repeated=True) type = _messages.StringField(2) class GetIamPolicyRequest(_messages.Message): r"""Request message for GetIamPolicy method. Fields: options: OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. """ options = _messages.MessageField('GetPolicyOptions', 1) class GetPolicyOptions(_messages.Message): r"""Encapsulates settings provided to GetIamPolicy. Fields: requestedPolicyVersion: Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). """ requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) class HandleQueryStep(_messages.Message): r"""A query step that reads the results of a step in a previous query operation as its input. Fields: queryStepHandle: Required. A handle to a query step from a previous call to QueryData. """ queryStepHandle = _messages.StringField(1) class HttpRequest(_messages.Message): r"""A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message. Fields: cacheFillBytes: The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted. cacheHit: Whether or not an entity was served from cache (with or without validation). cacheLookup: Whether or not a cache lookup was attempted. cacheValidatedWithOriginServer: 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: The request processing latency on the server, from the time the request was received until the response was sent. For WebSocket connections, this field refers to the entire time duration of the connection. protocol: Protocol used for the request. Examples: "HTTP/1.1", "HTTP/2" referer: The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (https://datatracker.ietf.org/doc/html/rfc2616#section-14.36). remoteIp: 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: The request method. Examples: "GET", "HEAD", "PUT", "POST". requestSize: The size of the HTTP request message in bytes, including the request headers and the request body. requestUrl: 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: The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body. serverIp: 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: The response code indicating the status of response. Examples: 200, 404. userAgent: The user agent sent by the client. Example: "Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)". """ cacheFillBytes = _messages.IntegerField(1) cacheHit = _messages.BooleanField(2) cacheLookup = _messages.BooleanField(3) cacheValidatedWithOriginServer = _messages.BooleanField(4) latency = _messages.StringField(5) protocol = _messages.StringField(6) referer = _messages.StringField(7) remoteIp = _messages.StringField(8) requestMethod = _messages.StringField(9) requestSize = _messages.IntegerField(10) requestUrl = _messages.StringField(11) responseSize = _messages.IntegerField(12) serverIp = _messages.StringField(13) status = _messages.IntegerField(14, variant=_messages.Variant.INT32) userAgent = _messages.StringField(15) class IndexConfig(_messages.Message): r"""Configuration for an indexed field. Enums: TypeValueValuesEnum: Required. The type of data in this index. Fields: createTime: 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: 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/analyze/custom-index) for details.For example: jsonPayload.request.status type: Required. The type of data in this index. """ class TypeValueValuesEnum(_messages.Enum): r"""Required. The type of data in this index. Values: INDEX_TYPE_UNSPECIFIED: The index's type is unspecified. INDEX_TYPE_STRING: The index is a string-type index. INDEX_TYPE_INTEGER: The index is a integer-type index. """ INDEX_TYPE_UNSPECIFIED = 0 INDEX_TYPE_STRING = 1 INDEX_TYPE_INTEGER = 2 createTime = _messages.StringField(1) fieldPath = _messages.StringField(2) type = _messages.EnumField('TypeValueValuesEnum', 3) class IntegerArrayValue(_messages.Message): r"""An array of integers within a parameter. Fields: values: Optional. The values of the array. """ values = _messages.IntegerField(1, repeated=True) class Interval(_messages.Message): r"""Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. Fields: endTime: Optional. Exclusive end of the interval.If specified, a Timestamp matching this interval will have to be before the end. startTime: Optional. Inclusive start of the interval.If specified, a Timestamp matching this interval will have to be the same or after the start. """ endTime = _messages.StringField(1) startTime = _messages.StringField(2) class LabelDescriptor(_messages.Message): r"""A description of a label. Enums: ValueTypeValueValuesEnum: The type of data that can be assigned to the label. Fields: description: A human-readable description for the label. key: The label key. valueType: The type of data that can be assigned to the label. """ class ValueTypeValueValuesEnum(_messages.Enum): r"""The type of data that can be assigned to the label. Values: STRING: A variable-length string. This is the default. BOOL: Boolean; true or false. INT64: A 64-bit signed integer. """ STRING = 0 BOOL = 1 INT64 = 2 description = _messages.StringField(1) key = _messages.StringField(2) valueType = _messages.EnumField('ValueTypeValueValuesEnum', 3) class Linear(_messages.Message): r"""Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 <= i < N-1): offset + (width * i).Lower bound (1 <= i < N): offset + (width * (i - 1)). Fields: numFiniteBuckets: Must be greater than 0. offset: Lower bound of the first bucket. width: Must be greater than 0. """ numFiniteBuckets = _messages.IntegerField(1, variant=_messages.Variant.INT32) offset = _messages.FloatField(2) width = _messages.FloatField(3) class Link(_messages.Message): r"""Describes a link connected to an analytics enabled bucket. Enums: LifecycleStateValueValuesEnum: Output only. The resource lifecycle state. Fields: bigqueryDataset: 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. createTime: Output only. The creation timestamp of the link. description: Optional. Describes this link.The maximum length of the description is 8000 characters. lifecycleState: Output only. The resource lifecycle state. name: 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/[PROJE CT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "org anizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID] /links/[LINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCAT ION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locati ons/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" For example:`projects/my-project/locations/global/buckets/my- bucket/links/my_link """ class LifecycleStateValueValuesEnum(_messages.Enum): r"""Output only. The resource lifecycle state. Values: LIFECYCLE_STATE_UNSPECIFIED: Unspecified state. This is only used/useful for distinguishing unset values. ACTIVE: The normal and active state. DELETE_REQUESTED: The resource has been marked for deletion by the user. For some resources (e.g. buckets), this can be reversed by an un- delete operation. UPDATING: The resource has been marked for an update by the user. It will remain in this state until the update is complete. CREATING: The resource has been marked for creation by the user. It will remain in this state until the creation is complete. FAILED: The resource is in an INTERNAL error state. ARCHIVED: The resource has been archived such that it can still be queried but can no longer be modified or used as a sink destination. The source bucket after a move bucket operation enters this state. """ LIFECYCLE_STATE_UNSPECIFIED = 0 ACTIVE = 1 DELETE_REQUESTED = 2 UPDATING = 3 CREATING = 4 FAILED = 5 ARCHIVED = 6 bigqueryDataset = _messages.MessageField('BigQueryDataset', 1) createTime = _messages.StringField(2) description = _messages.StringField(3) lifecycleState = _messages.EnumField('LifecycleStateValueValuesEnum', 4) name = _messages.StringField(5) class LinkMetadata(_messages.Message): r"""Metadata for long running Link operations. Enums: StateValueValuesEnum: Output only. State of an operation. Fields: createLinkRequest: CreateLink RPC request. deleteLinkRequest: DeleteLink RPC request. endTime: The end time of an operation. startTime: The start time of an operation. state: Output only. State of an operation. """ class StateValueValuesEnum(_messages.Enum): r"""Output only. State of an operation. Values: OPERATION_STATE_UNSPECIFIED: Should not be used. OPERATION_STATE_SCHEDULED: The operation is scheduled. OPERATION_STATE_WAITING_FOR_PERMISSIONS: Waiting for necessary permissions. OPERATION_STATE_RUNNING: The operation is running. OPERATION_STATE_SUCCEEDED: The operation was completed successfully. OPERATION_STATE_FAILED: The operation failed. OPERATION_STATE_CANCELLED: The operation was cancelled by the user. OPERATION_STATE_PENDING: The operation is waiting for quota. """ OPERATION_STATE_UNSPECIFIED = 0 OPERATION_STATE_SCHEDULED = 1 OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2 OPERATION_STATE_RUNNING = 3 OPERATION_STATE_SUCCEEDED = 4 OPERATION_STATE_FAILED = 5 OPERATION_STATE_CANCELLED = 6 OPERATION_STATE_PENDING = 7 createLinkRequest = _messages.MessageField('CreateLinkRequest', 1) deleteLinkRequest = _messages.MessageField('DeleteLinkRequest', 2) endTime = _messages.StringField(3) startTime = _messages.StringField(4) state = _messages.EnumField('StateValueValuesEnum', 5) class ListBucketsResponse(_messages.Message): r"""The response from ListBuckets. Fields: buckets: A list of buckets. nextPageToken: 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. """ buckets = _messages.MessageField('LogBucket', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListExclusionsResponse(_messages.Message): r"""Result returned from ListExclusions. Fields: exclusions: A list of exclusions. nextPageToken: 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. """ exclusions = _messages.MessageField('LogExclusion', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLinksResponse(_messages.Message): r"""The response from ListLinks. Fields: links: A list of links. nextPageToken: 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. """ links = _messages.MessageField('Link', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLocationsResponse(_messages.Message): r"""The response message for Locations.ListLocations. Fields: locations: A list of locations that matches the specified filter in the request. nextPageToken: The standard List next-page token. """ locations = _messages.MessageField('Location', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLogEntriesRequest(_messages.Message): r"""The parameters to ListLogEntries. Fields: filter: Optional. A filter that chooses which log entries to return. For more information, see Logging query language (https://cloud.google.com/logging/docs/view/logging-query-language).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.To make queries faster, you can make the filter more selective by using restrictions on indexed fields (https://cloud.google.com/logging/docs/view/logging-query- language#indexed-fields) as well as limit the time range of the query by adding range restrictions on the timestamp field. orderBy: 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.We recommend setting the order_by field to "timestamp desc" when listing recently ingested log entries. If not set, the default value of "timestamp asc" may take a long time to fetch matching logs that are only recently ingested. pageSize: Optional. The maximum number of results to return from this request. Default is 50. If the value is negative, the request is rejected.The presence of next_page_token in the response indicates that more results might be available. pageToken: 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. Deprecated. Use resource_names instead. One or more project identifiers or project numbers from which to retrieve log entries. Example: "my-project-1A". resourceNames: Required. Names of one or more parent resources from which to retrieve log entries. Resources may either be resource containers or specific LogViews. For the case of resource containers, all logs ingested into that container will be returned regardless of which LogBuckets they are actually stored in - i.e. these queries may fan out to multiple regions. In the event of region unavailability, specify a specific set of LogViews that do not include the unavailable region. projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] projects/[PROJE CT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organ izations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/v iews/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[L OCATION_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. """ filter = _messages.StringField(1) orderBy = _messages.StringField(2) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) projectIds = _messages.StringField(5, repeated=True) resourceNames = _messages.StringField(6, repeated=True) class ListLogEntriesResponse(_messages.Message): r"""Result returned from ListLogEntries. Fields: entries: 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: 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. """ entries = _messages.MessageField('LogEntry', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLogMetricsResponse(_messages.Message): r"""Result returned from ListLogMetrics. Fields: metrics: A list of logs-based metrics. nextPageToken: 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. """ metrics = _messages.MessageField('LogMetric', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLogScopesResponse(_messages.Message): r"""The response from ListLogScopes. Every project has a _Default log scope that cannot be modified or deleted. Fields: logScopes: A list of log scopes. nextPageToken: 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. """ logScopes = _messages.MessageField('LogScope', 1, repeated=True) nextPageToken = _messages.StringField(2) class ListLogsResponse(_messages.Message): r"""Result returned from ListLogs. Fields: logNames: A list of log names. For example, "projects/my- project/logs/syslog" or "organizations/123/logs/cloudresourcemanager.googleapis.com%2Factivity". nextPageToken: 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. """ logNames = _messages.StringField(1, repeated=True) nextPageToken = _messages.StringField(2) class ListMonitoredResourceDescriptorsResponse(_messages.Message): r"""Result returned from ListMonitoredResourceDescriptors. Fields: nextPageToken: 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: A list of resource descriptors. """ nextPageToken = _messages.StringField(1) resourceDescriptors = _messages.MessageField('MonitoredResourceDescriptor', 2, repeated=True) class ListOperationsResponse(_messages.Message): r"""The response message for Operations.ListOperations. Fields: nextPageToken: The standard List next-page token. operations: A list of operations that matches the specified filter in the request. unreachable: Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. """ nextPageToken = _messages.StringField(1) operations = _messages.MessageField('Operation', 2, repeated=True) unreachable = _messages.StringField(3, repeated=True) class ListRecentQueriesResponse(_messages.Message): r"""The response from ListRecentQueries. Fields: nextPageToken: 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. recentQueries: A list of recent queries. unreachable: The unreachable resources. Each resource can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachable. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global/recentQueries/12345678" "projects/my-project/locations/global"If there are unreachable resources, the response will first return pages that contain recent queries, and then return pages that contain the unreachable resources. """ nextPageToken = _messages.StringField(1) recentQueries = _messages.MessageField('RecentQuery', 2, repeated=True) unreachable = _messages.StringField(3, repeated=True) class ListSavedQueriesResponse(_messages.Message): r"""The response from ListSavedQueries. Fields: nextPageToken: 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. savedQueries: A list of saved queries. unreachable: The unreachable resources. It can be either 1) a saved query if a specific query is unreachable or 2) a location if a specific location is unreachabe. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/global/savedQueries/12345678" "projects/my-project/locations/global" If there are unreachable resources, the response will first return pages that contain saved queries, and then return pages that contain the unreachable resources. """ nextPageToken = _messages.StringField(1) savedQueries = _messages.MessageField('SavedQuery', 2, repeated=True) unreachable = _messages.StringField(3, repeated=True) class ListSinksResponse(_messages.Message): r"""Result returned from ListSinks. Fields: nextPageToken: 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: A list of sinks. """ nextPageToken = _messages.StringField(1) sinks = _messages.MessageField('LogSink', 2, repeated=True) class ListViewsResponse(_messages.Message): r"""The response from ListViews. Fields: nextPageToken: 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: A list of views. """ nextPageToken = _messages.StringField(1) views = _messages.MessageField('LogView', 2, repeated=True) class Location(_messages.Message): r"""A resource that represents a Google Cloud location. Messages: LabelsValue: Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} MetadataValue: Service-specific metadata. For example the available capacity at the given location. Fields: displayName: The friendly name for this location, typically a nearby city name. For example, "Tokyo". labels: Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} locationId: The canonical id for this location. For example: "us-east1". metadata: Service-specific metadata. For example the available capacity at the given location. name: Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us- east1" """ @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class MetadataValue(_messages.Message): r"""Service-specific metadata. For example the available capacity at the given location. Messages: AdditionalProperty: An additional property for a MetadataValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a MetadataValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) displayName = _messages.StringField(1) labels = _messages.MessageField('LabelsValue', 2) locationId = _messages.StringField(3) metadata = _messages.MessageField('MetadataValue', 4) name = _messages.StringField(5) class LocationMetadata(_messages.Message): r"""Cloud Logging specific location metadata. Fields: logAnalyticsEnabled: Indicates whether or not Log Analytics features are supported in the given location. """ logAnalyticsEnabled = _messages.BooleanField(1) class LogBucket(_messages.Message): r"""Describes a repository in which log entries are stored. Enums: LifecycleStateValueValuesEnum: Output only. The bucket lifecycle state. UnmetAnalyticsUpgradeRequirementsValueListEntryValuesEnum: Messages: TagsValue: Optional. Input only. Immutable. Tag keys/values directly bound to this bucket. Each item in the map must be expressed as " : ". tag- key-namespaced-name is the project_number/tag-key-short-name For example: "123/environment" : "production", "123/costCenter" : "marketing" Fields: analyticsEnabled: Optional. Whether log analytics is enabled for this bucket.Once enabled, log analytics features cannot be disabled. analyticsUpgradeTime: Output only. The time that the bucket was upgraded to enable analytics. This will eventually be deprecated once there is not a need to upgrade existing buckets (i.e. when analytics becomes default-enabled). cmekSettings: 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. createTime: Output only. The creation timestamp of the bucket. This is not set for any of the default buckets. description: Optional. Describes this bucket. indexConfigs: Optional. A list of indexed fields and related configuration data. lifecycleState: Output only. The bucket lifecycle state. locked: 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. name: 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. 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. 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. tags: Optional. Input only. Immutable. Tag keys/values directly bound to this bucket. Each item in the map must be expressed as " : ". tag-key- namespaced-name is the project_number/tag-key-short-name For example: "123/environment" : "production", "123/costCenter" : "marketing" unmetAnalyticsUpgradeRequirements: Output only. The requirements for an upgrade to analytics that are not satisfied by the current bucket configuration, in an arbitrary order. This will eventually be deprecated once there is not a need to upgrade existing buckets (i.e. when analytics becomes default-enabled). updateTime: Output only. The last update timestamp of the bucket. """ class LifecycleStateValueValuesEnum(_messages.Enum): r"""Output only. The bucket lifecycle state. Values: LIFECYCLE_STATE_UNSPECIFIED: Unspecified state. This is only used/useful for distinguishing unset values. ACTIVE: The normal and active state. DELETE_REQUESTED: The resource has been marked for deletion by the user. For some resources (e.g. buckets), this can be reversed by an un- delete operation. UPDATING: The resource has been marked for an update by the user. It will remain in this state until the update is complete. CREATING: The resource has been marked for creation by the user. It will remain in this state until the creation is complete. FAILED: The resource is in an INTERNAL error state. ARCHIVED: The resource has been archived such that it can still be queried but can no longer be modified or used as a sink destination. The source bucket after a move bucket operation enters this state. """ LIFECYCLE_STATE_UNSPECIFIED = 0 ACTIVE = 1 DELETE_REQUESTED = 2 UPDATING = 3 CREATING = 4 FAILED = 5 ARCHIVED = 6 class UnmetAnalyticsUpgradeRequirementsValueListEntryValuesEnum(_messages.Enum): r"""UnmetAnalyticsUpgradeRequirementsValueListEntryValuesEnum enum type. Values: REQUIREMENT_UNSPECIFIED: Unexpected default. ACTIVE_LIFECYCLE_STATE: The requirement that a bucket must be in the ACTIVE lifecycle state. GLOBAL_BUCKET_REGION: The requirement that a bucket must be in the "global" region. This requirement is deprecated and replaced with SUPPORTED_BUCKET_REGION. DEFAULT_RETENTION_DURATION: The requirement that buckets other than the "_Required" bucket must have the default retention duration of 30 days set. This requirement is deprecated as buckets with custom retention can now upgrade to Log Analytics. REQUIRED_RETENTION_DURATION: The requirement that the "_Required" bucket must have its default retention of 400 days set. FIELD_LEVEL_ACCESS_CONTROLS_UNSET: The requirement that no field level access controls are configured for the bucket. This requirement is deprecated as buckets with restricted field ACLs can now be upgraded to Log Analytics. However, the following applies: 1. Users who do not have access to the restricted fields will not be able to query any views in the bucket using Log Analytics. 2. Users who have access to all restricted fields can query any views they have access to in the bucket using Log Analytics. 3. If a linked dataset exists in the bucket, all data accessible via views in the bucket is queryable via the linked dataset in BigQuery. Field level ACLs should be applied to linked datasets using BigQuery access control mechanisms. CMEK_UNSET: The requirement that no CMEK configuration is set for the bucket. This requirement is deprecated as buckets with CMEK can now be upgraded to Log Analytics. NOT_LOCKED: The requirement that the bucket is not locked. ORGANIZATION_BUCKET: The requirement that the bucket must not be contained within an org. FOLDER_BUCKET: The requirement that the bucket must not be contained within a folder. BILLING_ACCOUNT_BUCKET: The requirement that the bucket must not be contained within a billing account. SUPPORTED_BUCKET_REGION: The requirement that the bucket must be in a region supported by Log Analytics. """ REQUIREMENT_UNSPECIFIED = 0 ACTIVE_LIFECYCLE_STATE = 1 GLOBAL_BUCKET_REGION = 2 DEFAULT_RETENTION_DURATION = 3 REQUIRED_RETENTION_DURATION = 4 FIELD_LEVEL_ACCESS_CONTROLS_UNSET = 5 CMEK_UNSET = 6 NOT_LOCKED = 7 ORGANIZATION_BUCKET = 8 FOLDER_BUCKET = 9 BILLING_ACCOUNT_BUCKET = 10 SUPPORTED_BUCKET_REGION = 11 @encoding.MapUnrecognizedFields('additionalProperties') class TagsValue(_messages.Message): r"""Optional. Input only. Immutable. Tag keys/values directly bound to this bucket. Each item in the map must be expressed as " : ". tag-key- namespaced-name is the project_number/tag-key-short-name For example: "123/environment" : "production", "123/costCenter" : "marketing" Messages: AdditionalProperty: An additional property for a TagsValue object. Fields: additionalProperties: Additional properties of type TagsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a TagsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) analyticsEnabled = _messages.BooleanField(1) analyticsUpgradeTime = _messages.StringField(2) cmekSettings = _messages.MessageField('CmekSettings', 3) createTime = _messages.StringField(4) description = _messages.StringField(5) indexConfigs = _messages.MessageField('IndexConfig', 6, repeated=True) lifecycleState = _messages.EnumField('LifecycleStateValueValuesEnum', 7) locked = _messages.BooleanField(8) name = _messages.StringField(9) restrictedFields = _messages.StringField(10, repeated=True) retentionDays = _messages.IntegerField(11, variant=_messages.Variant.INT32) tags = _messages.MessageField('TagsValue', 12) unmetAnalyticsUpgradeRequirements = _messages.EnumField('UnmetAnalyticsUpgradeRequirementsValueListEntryValuesEnum', 13, repeated=True) updateTime = _messages.StringField(14) class LogEntry(_messages.Message): r"""An individual entry in a log. Enums: SeverityValueValuesEnum: Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT. Messages: JsonPayloadValue: The log entry payload, represented as a structure that is expressed as a JSON object. LabelsValue: 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. ProtoPayloadValue: 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" Fields: apphub: Output only. AppHub application metadata associated with this LogEntry. May be empty if there is no associated AppHub application or multiple associated applications (such as for VPC flow logs) apphubDestination: Output only. AppHub application metadata associated with the destination application. This is only populated if the log represented "edge"-like data (such as for VPC flow logs) with a source and destination. errorGroups: Output only. The Error Reporting (https://cloud.google.com/error-reporting) error groups associated with this LogEntry. Error Reporting sets the values for this field during error group creation.For more information, see View error details( https://cloud.google.com/error-reporting/docs/viewing- errors#view_error_details)This field isn't available during log routing (https://cloud.google.com/logging/docs/routing/overview) httpRequest: Optional. Information about the HTTP request associated with this log entry, if applicable. insertId: 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: The log entry payload, represented as a structure that is expressed as a JSON object. labels: 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: 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.g oogleapis.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 processed 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: Output only. Deprecated. This field is not used by Logging. Any value written to it is cleared. operation: Optional. Information about an operation associated with the log entry, if applicable. protoPayload: 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: Output only. The time the log entry was received by Logging. resource: 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. The severity of the log entry. The default value is LogSeverity.DEFAULT. sourceLocation: Optional. Source code location information associated with the log entry, if any. spanId: 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. Information indicating this LogEntry is part of a sequence of multiple log entries split from a single LogEntry. textPayload: The log entry payload, represented as a Unicode string (UTF-8). timestamp: 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 are rejected by Logging. trace: 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-trace-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. The sampling decision of the span associated with the log entry at the time the log entry was created. This field corresponds to the sampled flag in the W3C trace-context specification (https://www.w3.org/TR/trace-context/#sampled-flag). A non-sampled trace value is still useful as a request correlation identifier. The default is False. """ class SeverityValueValuesEnum(_messages.Enum): r"""Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT. Values: DEFAULT: (0) The log entry has no assigned severity level. DEBUG: (100) Debug or trace information. INFO: (200) Routine information, such as ongoing status or performance. NOTICE: (300) Normal but significant events, such as start up, shut down, or a configuration change. WARNING: (400) Warning events might cause problems. ERROR: (500) Error events are likely to cause problems. CRITICAL: (600) Critical events cause more severe problems or outages. ALERT: (700) A person must take an action immediately. EMERGENCY: (800) One or more systems are unusable. """ DEFAULT = 0 DEBUG = 1 INFO = 2 NOTICE = 3 WARNING = 4 ERROR = 5 CRITICAL = 6 ALERT = 7 EMERGENCY = 8 @encoding.MapUnrecognizedFields('additionalProperties') class JsonPayloadValue(_messages.Message): r"""The log entry payload, represented as a structure that is expressed as a JSON object. Messages: AdditionalProperty: An additional property for a JsonPayloadValue object. Fields: additionalProperties: Properties of the object. """ class AdditionalProperty(_messages.Message): r"""An additional property for a JsonPayloadValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""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. Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class ProtoPayloadValue(_messages.Message): r"""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" Messages: AdditionalProperty: An additional property for a ProtoPayloadValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a ProtoPayloadValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) apphub = _messages.MessageField('AppHub', 1) apphubDestination = _messages.MessageField('AppHub', 2) errorGroups = _messages.MessageField('LogErrorGroup', 3, repeated=True) httpRequest = _messages.MessageField('HttpRequest', 4) insertId = _messages.StringField(5) jsonPayload = _messages.MessageField('JsonPayloadValue', 6) labels = _messages.MessageField('LabelsValue', 7) logName = _messages.StringField(8) metadata = _messages.MessageField('MonitoredResourceMetadata', 9) operation = _messages.MessageField('LogEntryOperation', 10) protoPayload = _messages.MessageField('ProtoPayloadValue', 11) receiveTimestamp = _messages.StringField(12) resource = _messages.MessageField('MonitoredResource', 13) severity = _messages.EnumField('SeverityValueValuesEnum', 14) sourceLocation = _messages.MessageField('LogEntrySourceLocation', 15) spanId = _messages.StringField(16) split = _messages.MessageField('LogSplit', 17) textPayload = _messages.StringField(18) timestamp = _messages.StringField(19) trace = _messages.StringField(20) traceSampled = _messages.BooleanField(21) class LogEntryOperation(_messages.Message): r"""Additional information about a potentially long-running operation with which a log entry is associated. Fields: first: Optional. Set this to True if this is the first log entry in the operation. id: Optional. An arbitrary operation identifier. Log entries with the same identifier are assumed to be part of the same operation. last: Optional. Set this to True if this is the last log entry in the operation. producer: 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". """ first = _messages.BooleanField(1) id = _messages.StringField(2) last = _messages.BooleanField(3) producer = _messages.StringField(4) class LogEntrySourceLocation(_messages.Message): r"""Additional information about the source code location that produced the log entry. Fields: file: Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. function: 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. Line within the source file. 1-based; 0 indicates no line number available. """ file = _messages.StringField(1) function = _messages.StringField(2) line = _messages.IntegerField(3) class LogErrorGroup(_messages.Message): r"""Contains metadata that associates the LogEntry to Error Reporting error groups. Fields: id: The id is a unique identifier for a particular error group; it is the last part of the error group resource name: /project/[PROJECT_ID]/errors/[ERROR_GROUP_ID]. Example: COShysOX0r_51QE. The id is derived from key parts of the error-log content and is treated as Service Data. For information about how Service Data is handled, see Google Cloud Privacy Notice (https://cloud.google.com/terms/cloud- privacy-notice). """ id = _messages.StringField(1) class LogExclusion(_messages.Message): r"""Specifies a set of log entries that are filtered out by a sink. If your Google Cloud resource receives a large volume of log entries, you can use exclusions to reduce your chargeable logs. Note that exclusions on organization-level and folder-level sinks don't apply to child resources. Note also that you cannot modify the _Required sink or exclude logs from it. Fields: createTime: Output only. The creation timestamp of the exclusion.This field may not be present for older exclusions. description: Optional. A description of this exclusion. disabled: 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: 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" The maximum length of the filter is 20000 characters. labelExtractors: 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. 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: 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". resourceName: Output only. The resource name of the metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" updateTime: Output only. The last update timestamp of the metric.This field may not be present for older metrics. valueExtractor: 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: Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. """ class VersionValueValuesEnum(_messages.Enum): r"""Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed. Values: V2: Logging API v2. V1: Logging API v1. """ V2 = 0 V1 = 1 @encoding.MapUnrecognizedFields('additionalProperties') class LabelExtractorsValue(_messages.Message): r"""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. Messages: AdditionalProperty: An additional property for a LabelExtractorsValue object. Fields: additionalProperties: Additional properties of type LabelExtractorsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelExtractorsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) bucketName = _messages.StringField(1) bucketOptions = _messages.MessageField('BucketOptions', 2) createTime = _messages.StringField(3) description = _messages.StringField(4) disabled = _messages.BooleanField(5) filter = _messages.StringField(6) labelExtractors = _messages.MessageField('LabelExtractorsValue', 7) metricDescriptor = _messages.MessageField('MetricDescriptor', 8) name = _messages.StringField(9) resourceName = _messages.StringField(10) updateTime = _messages.StringField(11) valueExtractor = _messages.StringField(12) version = _messages.EnumField('VersionValueValuesEnum', 13) class LogScope(_messages.Message): r"""Describes a group of resources to read log entries from. Fields: createTime: Output only. The creation timestamp of the log scope. description: Optional. Describes this log scope.The maximum length of the description is 8000 characters. name: Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my- project/locations/global/logScopes/my-log-scope resourceNames: Required. Names of one or more parent resources (organizations and folders are not supported.): projects/[PROJECT_ID]May alternatively be one or more views: projects/[PROJECT_ID]/locations/[LOC ATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]A log scope can include a maximum of 5 projects and a maximum of 100 resources in total. updateTime: Output only. The last update timestamp of the log scope. """ createTime = _messages.StringField(1) description = _messages.StringField(2) name = _messages.StringField(3) resourceNames = _messages.StringField(4, repeated=True) updateTime = _messages.StringField(5) class LogSink(_messages.Message): r"""Describes a sink used to export log entries to one of the following destinations: a Cloud Logging log bucket, a Cloud Storage bucket, a BigQuery dataset, a Pub/Sub topic, a Cloud project.A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder. Enums: OutputVersionFormatValueValuesEnum: Deprecated. This field is unused. Fields: bigqueryOptions: Optional. Options that affect sinks exporting data to BigQuery. createTime: Output only. The creation timestamp of the sink.This field may not be present for older sinks. description: Optional. A description of this sink.The maximum length of the description is 8000 characters. destination: 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]" "logging.googleapis.com/projects/[PROJECT_ID]" "logging.googleapis.com/p rojects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_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. If set to true, then this sink is disabled and it does not export any log entries. exclusions: 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 exclusions it will not be exported. filter: 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. 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 interceptChildren: Optional. This field applies only to sinks owned by organizations and folders.When the value of 'intercept_children' is true, the following restrictions apply: The sink must have the include_children flag set to true. The sink destination must be a Cloud project.Also, the following behaviors apply: Any logs matched by the sink won't be included by non-_Required sinks owned by child resources. The sink appears in the results of a ListSinks call from a child resource if the value of the filter field in its request is either 'in_scope("ALL")' or 'in_scope("ANCESTOR")'. name: Optional. 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. outputVersionFormat: Deprecated. This field is unused. resourceName: Output only. The resource name of the sink. "projects/[PROJECT_ID]/sinks/[SINK_NAME] "organizations/[ORGANIZATION_ID]/sinks/[SINK_NAME] "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_NAME] "folders/[FOLDER_ID]/sinks/[SINK_NAME] For example: projects/my_project/sinks/SINK_NAME updateTime: Output only. The last update timestamp of the sink.This field may not be present for older sinks. writerIdentity: 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 OutputVersionFormatValueValuesEnum(_messages.Enum): r"""Deprecated. This field is unused. Values: VERSION_FORMAT_UNSPECIFIED: An unspecified format version that will default to V2. V2: LogEntry version 2 format. V1: LogEntry version 1 format. """ VERSION_FORMAT_UNSPECIFIED = 0 V2 = 1 V1 = 2 bigqueryOptions = _messages.MessageField('BigQueryOptions', 1) createTime = _messages.StringField(2) description = _messages.StringField(3) destination = _messages.StringField(4) disabled = _messages.BooleanField(5) exclusions = _messages.MessageField('LogExclusion', 6, repeated=True) filter = _messages.StringField(7) includeChildren = _messages.BooleanField(8) interceptChildren = _messages.BooleanField(9) name = _messages.StringField(10) outputVersionFormat = _messages.EnumField('OutputVersionFormatValueValuesEnum', 11) resourceName = _messages.StringField(12) updateTime = _messages.StringField(13) writerIdentity = _messages.StringField(14) class LogSplit(_messages.Message): r"""Additional information used to correlate multiple log entries. Used when a single LogEntry would exceed the Google Cloud Logging size limit and is split across multiple log entries. Fields: index: 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: The total number of log entries that the original LogEntry was split into. uid: 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. """ index = _messages.IntegerField(1, variant=_messages.Variant.INT32) totalSplits = _messages.IntegerField(2, variant=_messages.Variant.INT32) uid = _messages.StringField(3) class LogView(_messages.Message): r"""Describes a view over log entries in a bucket. Fields: createTime: Output only. The creation timestamp of the view. description: Optional. Describes this view. filter: 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") name: Output only. The resource name of the view.For example:projects/my- project/locations/global/buckets/my-bucket/views/my-view schema: Output only. Describes the schema of the logs stored in the bucket that are accessible via this view.This field is only populated for views in analytics-enabled buckets. updateTime: Output only. The last update timestamp of the view. """ createTime = _messages.StringField(1) description = _messages.StringField(2) filter = _messages.StringField(3) name = _messages.StringField(4) schema = _messages.MessageField('TableSchema', 5) updateTime = _messages.StringField(6) class LoggingBillingAccountsExclusionsCreateRequest(_messages.Message): r"""A LoggingBillingAccountsExclusionsCreateRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. parent: Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" """ logExclusion = _messages.MessageField('LogExclusion', 1) parent = _messages.StringField(2, required=True) class LoggingBillingAccountsExclusionsDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsExclusionsDeleteRequest object. Fields: name: Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsExclusionsGetRequest(_messages.Message): r"""A LoggingBillingAccountsExclusionsGetRequest object. Fields: name: Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsExclusionsListRequest(_messages.Message): r"""A LoggingBillingAccountsExclusionsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsExclusionsPatchRequest(_messages.Message): r"""A LoggingBillingAccountsExclusionsPatchRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. name: Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" updateMask: Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". """ logExclusion = _messages.MessageField('LogExclusion', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingBillingAccountsGetCmekSettingsRequest(_messages.Message): r"""A LoggingBillingAccountsGetCmekSettingsRequest object. Fields: name: Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsGetSettingsRequest(_messages.Message): r"""A LoggingBillingAccountsGetSettingsRequest object. Fields: name: Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsCreateAsyncRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsCreateAsyncRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsCreateRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsCreateRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsDeleteRequest object. Fields: name: Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsGetRequest object. Fields: name: Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsLinksCreateRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsLinksCreateRequest object. Fields: link: A Link resource to be passed as the request body. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsLinksDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsLinksDeleteRequest object. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsLinksGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsLinksGetRequest object. Fields: name: Required. The resource name of the link: "projects/[PROJECT_ID]/loca tions/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/ [ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LIN K_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buc kets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATI ON_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsLinksListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsLinksListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. parent: Required. The parent resource whose links are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsPatchRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsPatchRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingBillingAccountsLocationsBucketsUndeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsUndeleteRequest object. Fields: name: Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" undeleteBucketRequest: A UndeleteBucketRequest resource to be passed as the request body. """ name = _messages.StringField(1, required=True) undeleteBucketRequest = _messages.MessageField('UndeleteBucketRequest', 2) class LoggingBillingAccountsLocationsBucketsUpdateAsyncRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsUpdateAsyncRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingBillingAccountsLocationsBucketsViewsCreateRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsCreateRequest object. Fields: logView: A LogView resource to be passed as the request body. parent: Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" viewId: Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. """ logView = _messages.MessageField('LogView', 1) parent = _messages.StringField(2, required=True) viewId = _messages.StringField(3) class LoggingBillingAccountsLocationsBucketsViewsDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsDeleteRequest object. Fields: name: Required. The full resource name of the view to delete: "projects/[P ROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsViewsGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsGetRequest object. Fields: name: Required. The resource name of the policy: "projects/[PROJECT_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsBucketsViewsListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingBillingAccountsLocationsBucketsViewsLogsListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingBillingAccountsLocationsBucketsViewsPatchRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsBucketsViewsPatchRequest object. Fields: logView: A LogView resource to be passed as the request body. name: Required. The full resource name of the view to update "projects/[PR OJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" updateMask: Optional. Field mask that specifies the fields in view that need an update. A 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=filter """ logView = _messages.MessageField('LogView', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingBillingAccountsLocationsGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsGetRequest object. Fields: name: Resource name for the location. """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsListRequest object. Fields: extraLocationTypes: Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. filter: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). name: The resource that owns the locations collection, if applicable. pageSize: The maximum number of results to return. If not set, the service selects a default. pageToken: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. """ extraLocationTypes = _messages.StringField(1, repeated=True) filter = _messages.StringField(2) name = _messages.StringField(3, required=True) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) class LoggingBillingAccountsLocationsOperationsApproveRedactionRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsOperationsApproveRedactionRequest object. Fields: name: Required. Name of the redaction operation.For example:"projects/my- project/locations/global/operations/my-operation" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsOperationsCancelRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsOperationsCancelRequest object. Fields: cancelOperationRequest: A CancelOperationRequest resource to be passed as the request body. name: The name of the operation resource to be cancelled. """ cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) name = _messages.StringField(2, required=True) class LoggingBillingAccountsLocationsOperationsGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsOperationsGetRequest object. Fields: name: The name of the operation resource. """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsOperationsListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsOperationsListRequest object. Fields: filter: The standard list filter. name: The name of the operation's parent resource. pageSize: The standard list page size. pageToken: The standard list page token. returnPartialSuccess: When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. """ filter = _messages.StringField(1) name = _messages.StringField(2, required=True) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) returnPartialSuccess = _messages.BooleanField(5) class LoggingBillingAccountsLocationsRecentQueriesListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsRecentQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my- project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingBillingAccountsLocationsSavedQueriesCreateRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsSavedQueriesCreateRequest object. Fields: parent: Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/global" "organizations/123456789/locations/us- central1" savedQuery: A SavedQuery resource to be passed as the request body. savedQueryId: Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is 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. """ parent = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) savedQueryId = _messages.StringField(3) class LoggingBillingAccountsLocationsSavedQueriesDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsSavedQueriesDeleteRequest object. Fields: name: Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsSavedQueriesGetRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsSavedQueriesGetRequest object. Fields: name: Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingBillingAccountsLocationsSavedQueriesListRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsSavedQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingBillingAccountsLocationsSavedQueriesPatchRequest(_messages.Message): r"""A LoggingBillingAccountsLocationsSavedQueriesPatchRequest object. Fields: name: Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket- regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. savedQuery: A SavedQuery resource to be passed as the request body. updateMask: Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". """ name = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) updateMask = _messages.StringField(3) class LoggingBillingAccountsLogsDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsLogsDeleteRequest object. Fields: logName: Required. The resource name of the log to delete: 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".For more information about log names, see LogEntry. """ logName = _messages.StringField(1, required=True) class LoggingBillingAccountsLogsListRequest(_messages.Message): r"""A LoggingBillingAccountsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingBillingAccountsSinksCreateRequest(_messages.Message): r"""A LoggingBillingAccountsSinksCreateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. parent: Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" uniqueWriterIdentity: Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account- types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) parent = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) class LoggingBillingAccountsSinksDeleteRequest(_messages.Message): r"""A LoggingBillingAccountsSinksDeleteRequest object. Fields: sinkName: Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingBillingAccountsSinksGetRequest(_messages.Message): r"""A LoggingBillingAccountsSinksGetRequest object. Fields: sinkName: Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingBillingAccountsSinksListRequest(_messages.Message): r"""A LoggingBillingAccountsSinksListRequest object. Fields: filter: Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingBillingAccountsSinksPatchRequest(_messages.Message): r"""A LoggingBillingAccountsSinksPatchRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingBillingAccountsSinksUpdateRequest(_messages.Message): r"""A LoggingBillingAccountsSinksUpdateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingExclusionsCreateRequest(_messages.Message): r"""A LoggingExclusionsCreateRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. parent: Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" """ logExclusion = _messages.MessageField('LogExclusion', 1) parent = _messages.StringField(2, required=True) class LoggingExclusionsDeleteRequest(_messages.Message): r"""A LoggingExclusionsDeleteRequest object. Fields: name: Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingExclusionsGetRequest(_messages.Message): r"""A LoggingExclusionsGetRequest object. Fields: name: Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingExclusionsListRequest(_messages.Message): r"""A LoggingExclusionsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingExclusionsPatchRequest(_messages.Message): r"""A LoggingExclusionsPatchRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. name: Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" updateMask: Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". """ logExclusion = _messages.MessageField('LogExclusion', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersExclusionsCreateRequest(_messages.Message): r"""A LoggingFoldersExclusionsCreateRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. parent: Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" """ logExclusion = _messages.MessageField('LogExclusion', 1) parent = _messages.StringField(2, required=True) class LoggingFoldersExclusionsDeleteRequest(_messages.Message): r"""A LoggingFoldersExclusionsDeleteRequest object. Fields: name: Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingFoldersExclusionsGetRequest(_messages.Message): r"""A LoggingFoldersExclusionsGetRequest object. Fields: name: Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingFoldersExclusionsListRequest(_messages.Message): r"""A LoggingFoldersExclusionsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersExclusionsPatchRequest(_messages.Message): r"""A LoggingFoldersExclusionsPatchRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. name: Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" updateMask: Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". """ logExclusion = _messages.MessageField('LogExclusion', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersGetCmekSettingsRequest(_messages.Message): r"""A LoggingFoldersGetCmekSettingsRequest object. Fields: name: Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. """ name = _messages.StringField(1, required=True) class LoggingFoldersGetSettingsRequest(_messages.Message): r"""A LoggingFoldersGetSettingsRequest object. Fields: name: Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsCreateAsyncRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsCreateAsyncRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsCreateRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsCreateRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsDeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsDeleteRequest object. Fields: name: Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsGetRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsGetRequest object. Fields: name: Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsLinksCreateRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsLinksCreateRequest object. Fields: link: A Link resource to be passed as the request body. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsLinksDeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsLinksDeleteRequest object. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsLinksGetRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsLinksGetRequest object. Fields: name: Required. The resource name of the link: "projects/[PROJECT_ID]/loca tions/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/ [ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LIN K_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buc kets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATI ON_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsLinksListRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsLinksListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. parent: Required. The parent resource whose links are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsListRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsPatchRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsPatchRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersLocationsBucketsUndeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsUndeleteRequest object. Fields: name: Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" undeleteBucketRequest: A UndeleteBucketRequest resource to be passed as the request body. """ name = _messages.StringField(1, required=True) undeleteBucketRequest = _messages.MessageField('UndeleteBucketRequest', 2) class LoggingFoldersLocationsBucketsUpdateAsyncRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsUpdateAsyncRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersLocationsBucketsViewsCreateRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsCreateRequest object. Fields: logView: A LogView resource to be passed as the request body. parent: Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" viewId: Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. """ logView = _messages.MessageField('LogView', 1) parent = _messages.StringField(2, required=True) viewId = _messages.StringField(3) class LoggingFoldersLocationsBucketsViewsDeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsDeleteRequest object. Fields: name: Required. The full resource name of the view to delete: "projects/[P ROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsViewsGetIamPolicyRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsGetIamPolicyRequest object. Fields: getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the request body. resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. """ getIamPolicyRequest = _messages.MessageField('GetIamPolicyRequest', 1) resource = _messages.StringField(2, required=True) class LoggingFoldersLocationsBucketsViewsGetRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsGetRequest object. Fields: name: Required. The resource name of the policy: "projects/[PROJECT_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsBucketsViewsListRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsBucketsViewsLogsListRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingFoldersLocationsBucketsViewsPatchRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsPatchRequest object. Fields: logView: A LogView resource to be passed as the request body. name: Required. The full resource name of the view to update "projects/[PR OJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" updateMask: Optional. Field mask that specifies the fields in view that need an update. A 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=filter """ logView = _messages.MessageField('LogView', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersLocationsBucketsViewsSetIamPolicyRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsSetIamPolicyRequest object. Fields: resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) class LoggingFoldersLocationsBucketsViewsTestIamPermissionsRequest(_messages.Message): r"""A LoggingFoldersLocationsBucketsViewsTestIamPermissionsRequest object. Fields: resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. testIamPermissionsRequest: A TestIamPermissionsRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) class LoggingFoldersLocationsGetRequest(_messages.Message): r"""A LoggingFoldersLocationsGetRequest object. Fields: name: Resource name for the location. """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsListRequest(_messages.Message): r"""A LoggingFoldersLocationsListRequest object. Fields: extraLocationTypes: Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. filter: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). name: The resource that owns the locations collection, if applicable. pageSize: The maximum number of results to return. If not set, the service selects a default. pageToken: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. """ extraLocationTypes = _messages.StringField(1, repeated=True) filter = _messages.StringField(2) name = _messages.StringField(3, required=True) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) class LoggingFoldersLocationsLogScopesCreateRequest(_messages.Message): r"""A LoggingFoldersLocationsLogScopesCreateRequest object. Fields: logScope: A LogScope resource to be passed as the request body. logScopeId: Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. parent: Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global" """ logScope = _messages.MessageField('LogScope', 1) logScopeId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsLogScopesDeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsLogScopesDeleteRequest object. Fields: name: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsLogScopesGetRequest(_messages.Message): r"""A LoggingFoldersLocationsLogScopesGetRequest object. Fields: name: Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsLogScopesListRequest(_messages.Message): r"""A LoggingFoldersLocationsLogScopesListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingFoldersLocationsLogScopesPatchRequest(_messages.Message): r"""A LoggingFoldersLocationsLogScopesPatchRequest object. Fields: logScope: A LogScope resource to be passed as the request body. name: Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my- project/locations/global/logScopes/my-log-scope updateMask: Optional. Field mask that specifies the fields in log_scope that need an update. A 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=description """ logScope = _messages.MessageField('LogScope', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingFoldersLocationsOperationsApproveRedactionRequest(_messages.Message): r"""A LoggingFoldersLocationsOperationsApproveRedactionRequest object. Fields: name: Required. Name of the redaction operation.For example:"projects/my- project/locations/global/operations/my-operation" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsOperationsCancelRequest(_messages.Message): r"""A LoggingFoldersLocationsOperationsCancelRequest object. Fields: cancelOperationRequest: A CancelOperationRequest resource to be passed as the request body. name: The name of the operation resource to be cancelled. """ cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) name = _messages.StringField(2, required=True) class LoggingFoldersLocationsOperationsGetRequest(_messages.Message): r"""A LoggingFoldersLocationsOperationsGetRequest object. Fields: name: The name of the operation resource. """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsOperationsListRequest(_messages.Message): r"""A LoggingFoldersLocationsOperationsListRequest object. Fields: filter: The standard list filter. name: The name of the operation's parent resource. pageSize: The standard list page size. pageToken: The standard list page token. returnPartialSuccess: When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. """ filter = _messages.StringField(1) name = _messages.StringField(2, required=True) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) returnPartialSuccess = _messages.BooleanField(5) class LoggingFoldersLocationsRecentQueriesListRequest(_messages.Message): r"""A LoggingFoldersLocationsRecentQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my- project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingFoldersLocationsSavedQueriesCreateRequest(_messages.Message): r"""A LoggingFoldersLocationsSavedQueriesCreateRequest object. Fields: parent: Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/global" "organizations/123456789/locations/us- central1" savedQuery: A SavedQuery resource to be passed as the request body. savedQueryId: Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is 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. """ parent = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) savedQueryId = _messages.StringField(3) class LoggingFoldersLocationsSavedQueriesDeleteRequest(_messages.Message): r"""A LoggingFoldersLocationsSavedQueriesDeleteRequest object. Fields: name: Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsSavedQueriesGetRequest(_messages.Message): r"""A LoggingFoldersLocationsSavedQueriesGetRequest object. Fields: name: Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingFoldersLocationsSavedQueriesListRequest(_messages.Message): r"""A LoggingFoldersLocationsSavedQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingFoldersLocationsSavedQueriesPatchRequest(_messages.Message): r"""A LoggingFoldersLocationsSavedQueriesPatchRequest object. Fields: name: Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket- regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. savedQuery: A SavedQuery resource to be passed as the request body. updateMask: Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". """ name = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) updateMask = _messages.StringField(3) class LoggingFoldersLogsDeleteRequest(_messages.Message): r"""A LoggingFoldersLogsDeleteRequest object. Fields: logName: Required. The resource name of the log to delete: 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".For more information about log names, see LogEntry. """ logName = _messages.StringField(1, required=True) class LoggingFoldersLogsListRequest(_messages.Message): r"""A LoggingFoldersLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingFoldersSinksCreateRequest(_messages.Message): r"""A LoggingFoldersSinksCreateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. parent: Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" uniqueWriterIdentity: Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account- types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) parent = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) class LoggingFoldersSinksDeleteRequest(_messages.Message): r"""A LoggingFoldersSinksDeleteRequest object. Fields: sinkName: Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingFoldersSinksGetRequest(_messages.Message): r"""A LoggingFoldersSinksGetRequest object. Fields: sinkName: Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingFoldersSinksListRequest(_messages.Message): r"""A LoggingFoldersSinksListRequest object. Fields: filter: Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingFoldersSinksPatchRequest(_messages.Message): r"""A LoggingFoldersSinksPatchRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingFoldersSinksUpdateRequest(_messages.Message): r"""A LoggingFoldersSinksUpdateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingFoldersUpdateSettingsRequest(_messages.Message): r"""A LoggingFoldersUpdateSettingsRequest object. Fields: name: Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" settings: A Settings resource to be passed as the request body. updateMask: Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" """ name = _messages.StringField(1, required=True) settings = _messages.MessageField('Settings', 2) updateMask = _messages.StringField(3) class LoggingGetCmekSettingsRequest(_messages.Message): r"""A LoggingGetCmekSettingsRequest object. Fields: name: Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. """ name = _messages.StringField(1, required=True) class LoggingGetSettingsRequest(_messages.Message): r"""A LoggingGetSettingsRequest object. Fields: name: Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsCreateAsyncRequest(_messages.Message): r"""A LoggingLocationsBucketsCreateAsyncRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsCreateRequest(_messages.Message): r"""A LoggingLocationsBucketsCreateRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsDeleteRequest(_messages.Message): r"""A LoggingLocationsBucketsDeleteRequest object. Fields: name: Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsGetRequest(_messages.Message): r"""A LoggingLocationsBucketsGetRequest object. Fields: name: Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsLinksCreateRequest(_messages.Message): r"""A LoggingLocationsBucketsLinksCreateRequest object. Fields: link: A Link resource to be passed as the request body. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsLinksDeleteRequest(_messages.Message): r"""A LoggingLocationsBucketsLinksDeleteRequest object. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsLinksGetRequest(_messages.Message): r"""A LoggingLocationsBucketsLinksGetRequest object. Fields: name: Required. The resource name of the link: "projects/[PROJECT_ID]/loca tions/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/ [ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LIN K_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buc kets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATI ON_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsLinksListRequest(_messages.Message): r"""A LoggingLocationsBucketsLinksListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. parent: Required. The parent resource whose links are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsListRequest(_messages.Message): r"""A LoggingLocationsBucketsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsPatchRequest(_messages.Message): r"""A LoggingLocationsBucketsPatchRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingLocationsBucketsUndeleteRequest(_messages.Message): r"""A LoggingLocationsBucketsUndeleteRequest object. Fields: name: Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" undeleteBucketRequest: A UndeleteBucketRequest resource to be passed as the request body. """ name = _messages.StringField(1, required=True) undeleteBucketRequest = _messages.MessageField('UndeleteBucketRequest', 2) class LoggingLocationsBucketsUpdateAsyncRequest(_messages.Message): r"""A LoggingLocationsBucketsUpdateAsyncRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingLocationsBucketsViewsCreateRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsCreateRequest object. Fields: logView: A LogView resource to be passed as the request body. parent: Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" viewId: Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. """ logView = _messages.MessageField('LogView', 1) parent = _messages.StringField(2, required=True) viewId = _messages.StringField(3) class LoggingLocationsBucketsViewsDeleteRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsDeleteRequest object. Fields: name: Required. The full resource name of the view to delete: "projects/[P ROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsViewsGetIamPolicyRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsGetIamPolicyRequest object. Fields: getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the request body. resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. """ getIamPolicyRequest = _messages.MessageField('GetIamPolicyRequest', 1) resource = _messages.StringField(2, required=True) class LoggingLocationsBucketsViewsGetRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsGetRequest object. Fields: name: Required. The resource name of the policy: "projects/[PROJECT_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingLocationsBucketsViewsListRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingLocationsBucketsViewsPatchRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsPatchRequest object. Fields: logView: A LogView resource to be passed as the request body. name: Required. The full resource name of the view to update "projects/[PR OJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" updateMask: Optional. Field mask that specifies the fields in view that need an update. A 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=filter """ logView = _messages.MessageField('LogView', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingLocationsBucketsViewsSetIamPolicyRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsSetIamPolicyRequest object. Fields: resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) class LoggingLocationsBucketsViewsTestIamPermissionsRequest(_messages.Message): r"""A LoggingLocationsBucketsViewsTestIamPermissionsRequest object. Fields: resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. testIamPermissionsRequest: A TestIamPermissionsRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) class LoggingLocationsGetRequest(_messages.Message): r"""A LoggingLocationsGetRequest object. Fields: name: Resource name for the location. """ name = _messages.StringField(1, required=True) class LoggingLocationsListRequest(_messages.Message): r"""A LoggingLocationsListRequest object. Fields: extraLocationTypes: Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. filter: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). name: The resource that owns the locations collection, if applicable. pageSize: The maximum number of results to return. If not set, the service selects a default. pageToken: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. """ extraLocationTypes = _messages.StringField(1, repeated=True) filter = _messages.StringField(2) name = _messages.StringField(3, required=True) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) class LoggingLocationsOperationsApproveRedactionRequest(_messages.Message): r"""A LoggingLocationsOperationsApproveRedactionRequest object. Fields: name: Required. Name of the redaction operation.For example:"projects/my- project/locations/global/operations/my-operation" """ name = _messages.StringField(1, required=True) class LoggingLocationsOperationsCancelRequest(_messages.Message): r"""A LoggingLocationsOperationsCancelRequest object. Fields: cancelOperationRequest: A CancelOperationRequest resource to be passed as the request body. name: The name of the operation resource to be cancelled. """ cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) name = _messages.StringField(2, required=True) class LoggingLocationsOperationsGetRequest(_messages.Message): r"""A LoggingLocationsOperationsGetRequest object. Fields: name: The name of the operation resource. """ name = _messages.StringField(1, required=True) class LoggingLocationsOperationsListRequest(_messages.Message): r"""A LoggingLocationsOperationsListRequest object. Fields: filter: The standard list filter. name: The name of the operation's parent resource. pageSize: The standard list page size. pageToken: The standard list page token. returnPartialSuccess: When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. """ filter = _messages.StringField(1) name = _messages.StringField(2, required=True) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) returnPartialSuccess = _messages.BooleanField(5) class LoggingLogsDeleteRequest(_messages.Message): r"""A LoggingLogsDeleteRequest object. Fields: logName: Required. The resource name of the log to delete: 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".For more information about log names, see LogEntry. """ logName = _messages.StringField(1, required=True) class LoggingLogsListRequest(_messages.Message): r"""A LoggingLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingMonitoredResourceDescriptorsListRequest(_messages.Message): r"""A LoggingMonitoredResourceDescriptorsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) class LoggingOrganizationsExclusionsCreateRequest(_messages.Message): r"""A LoggingOrganizationsExclusionsCreateRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. parent: Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" """ logExclusion = _messages.MessageField('LogExclusion', 1) parent = _messages.StringField(2, required=True) class LoggingOrganizationsExclusionsDeleteRequest(_messages.Message): r"""A LoggingOrganizationsExclusionsDeleteRequest object. Fields: name: Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsExclusionsGetRequest(_messages.Message): r"""A LoggingOrganizationsExclusionsGetRequest object. Fields: name: Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsExclusionsListRequest(_messages.Message): r"""A LoggingOrganizationsExclusionsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsExclusionsPatchRequest(_messages.Message): r"""A LoggingOrganizationsExclusionsPatchRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. name: Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" updateMask: Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". """ logExclusion = _messages.MessageField('LogExclusion', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsGetCmekSettingsRequest(_messages.Message): r"""A LoggingOrganizationsGetCmekSettingsRequest object. Fields: name: Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. """ name = _messages.StringField(1, required=True) class LoggingOrganizationsGetSettingsRequest(_messages.Message): r"""A LoggingOrganizationsGetSettingsRequest object. Fields: name: Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsCreateAsyncRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsCreateAsyncRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsCreateRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsCreateRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsDeleteRequest object. Fields: name: Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsGetRequest object. Fields: name: Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsLinksCreateRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsLinksCreateRequest object. Fields: link: A Link resource to be passed as the request body. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsLinksDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsLinksDeleteRequest object. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsLinksGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsLinksGetRequest object. Fields: name: Required. The resource name of the link: "projects/[PROJECT_ID]/loca tions/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/ [ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LIN K_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buc kets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATI ON_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsLinksListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsLinksListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. parent: Required. The parent resource whose links are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsPatchRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsPatchRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsLocationsBucketsUndeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsUndeleteRequest object. Fields: name: Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" undeleteBucketRequest: A UndeleteBucketRequest resource to be passed as the request body. """ name = _messages.StringField(1, required=True) undeleteBucketRequest = _messages.MessageField('UndeleteBucketRequest', 2) class LoggingOrganizationsLocationsBucketsUpdateAsyncRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsUpdateAsyncRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsLocationsBucketsViewsCreateRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsCreateRequest object. Fields: logView: A LogView resource to be passed as the request body. parent: Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" viewId: Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. """ logView = _messages.MessageField('LogView', 1) parent = _messages.StringField(2, required=True) viewId = _messages.StringField(3) class LoggingOrganizationsLocationsBucketsViewsDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsDeleteRequest object. Fields: name: Required. The full resource name of the view to delete: "projects/[P ROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsViewsGetIamPolicyRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsGetIamPolicyRequest object. Fields: getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the request body. resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. """ getIamPolicyRequest = _messages.MessageField('GetIamPolicyRequest', 1) resource = _messages.StringField(2, required=True) class LoggingOrganizationsLocationsBucketsViewsGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsGetRequest object. Fields: name: Required. The resource name of the policy: "projects/[PROJECT_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsBucketsViewsListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsBucketsViewsLogsListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingOrganizationsLocationsBucketsViewsPatchRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsPatchRequest object. Fields: logView: A LogView resource to be passed as the request body. name: Required. The full resource name of the view to update "projects/[PR OJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" updateMask: Optional. Field mask that specifies the fields in view that need an update. A 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=filter """ logView = _messages.MessageField('LogView', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsLocationsBucketsViewsSetIamPolicyRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsSetIamPolicyRequest object. Fields: resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) class LoggingOrganizationsLocationsBucketsViewsTestIamPermissionsRequest(_messages.Message): r"""A LoggingOrganizationsLocationsBucketsViewsTestIamPermissionsRequest object. Fields: resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. testIamPermissionsRequest: A TestIamPermissionsRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) class LoggingOrganizationsLocationsGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsGetRequest object. Fields: name: Resource name for the location. """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsListRequest object. Fields: extraLocationTypes: Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. filter: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). name: The resource that owns the locations collection, if applicable. pageSize: The maximum number of results to return. If not set, the service selects a default. pageToken: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. """ extraLocationTypes = _messages.StringField(1, repeated=True) filter = _messages.StringField(2) name = _messages.StringField(3, required=True) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) class LoggingOrganizationsLocationsLogScopesCreateRequest(_messages.Message): r"""A LoggingOrganizationsLocationsLogScopesCreateRequest object. Fields: logScope: A LogScope resource to be passed as the request body. logScopeId: Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. parent: Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global" """ logScope = _messages.MessageField('LogScope', 1) logScopeId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsLogScopesDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsLogScopesDeleteRequest object. Fields: name: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsLogScopesGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsLogScopesGetRequest object. Fields: name: Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsLogScopesListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsLogScopesListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingOrganizationsLocationsLogScopesPatchRequest(_messages.Message): r"""A LoggingOrganizationsLocationsLogScopesPatchRequest object. Fields: logScope: A LogScope resource to be passed as the request body. name: Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my- project/locations/global/logScopes/my-log-scope updateMask: Optional. Field mask that specifies the fields in log_scope that need an update. A 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=description """ logScope = _messages.MessageField('LogScope', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsLocationsOperationsApproveRedactionRequest(_messages.Message): r"""A LoggingOrganizationsLocationsOperationsApproveRedactionRequest object. Fields: name: Required. Name of the redaction operation.For example:"projects/my- project/locations/global/operations/my-operation" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsOperationsCancelRequest(_messages.Message): r"""A LoggingOrganizationsLocationsOperationsCancelRequest object. Fields: cancelOperationRequest: A CancelOperationRequest resource to be passed as the request body. name: The name of the operation resource to be cancelled. """ cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) name = _messages.StringField(2, required=True) class LoggingOrganizationsLocationsOperationsGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsOperationsGetRequest object. Fields: name: The name of the operation resource. """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsOperationsListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsOperationsListRequest object. Fields: filter: The standard list filter. name: The name of the operation's parent resource. pageSize: The standard list page size. pageToken: The standard list page token. returnPartialSuccess: When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. """ filter = _messages.StringField(1) name = _messages.StringField(2, required=True) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) returnPartialSuccess = _messages.BooleanField(5) class LoggingOrganizationsLocationsRecentQueriesListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsRecentQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my- project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingOrganizationsLocationsSavedQueriesCreateRequest(_messages.Message): r"""A LoggingOrganizationsLocationsSavedQueriesCreateRequest object. Fields: parent: Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/global" "organizations/123456789/locations/us- central1" savedQuery: A SavedQuery resource to be passed as the request body. savedQueryId: Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is 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. """ parent = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) savedQueryId = _messages.StringField(3) class LoggingOrganizationsLocationsSavedQueriesDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLocationsSavedQueriesDeleteRequest object. Fields: name: Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsSavedQueriesGetRequest(_messages.Message): r"""A LoggingOrganizationsLocationsSavedQueriesGetRequest object. Fields: name: Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingOrganizationsLocationsSavedQueriesListRequest(_messages.Message): r"""A LoggingOrganizationsLocationsSavedQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingOrganizationsLocationsSavedQueriesPatchRequest(_messages.Message): r"""A LoggingOrganizationsLocationsSavedQueriesPatchRequest object. Fields: name: Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket- regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. savedQuery: A SavedQuery resource to be passed as the request body. updateMask: Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". """ name = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) updateMask = _messages.StringField(3) class LoggingOrganizationsLogsDeleteRequest(_messages.Message): r"""A LoggingOrganizationsLogsDeleteRequest object. Fields: logName: Required. The resource name of the log to delete: 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".For more information about log names, see LogEntry. """ logName = _messages.StringField(1, required=True) class LoggingOrganizationsLogsListRequest(_messages.Message): r"""A LoggingOrganizationsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingOrganizationsSinksCreateRequest(_messages.Message): r"""A LoggingOrganizationsSinksCreateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. parent: Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" uniqueWriterIdentity: Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account- types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) parent = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) class LoggingOrganizationsSinksDeleteRequest(_messages.Message): r"""A LoggingOrganizationsSinksDeleteRequest object. Fields: sinkName: Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingOrganizationsSinksGetRequest(_messages.Message): r"""A LoggingOrganizationsSinksGetRequest object. Fields: sinkName: Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingOrganizationsSinksListRequest(_messages.Message): r"""A LoggingOrganizationsSinksListRequest object. Fields: filter: Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingOrganizationsSinksPatchRequest(_messages.Message): r"""A LoggingOrganizationsSinksPatchRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingOrganizationsSinksUpdateRequest(_messages.Message): r"""A LoggingOrganizationsSinksUpdateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingOrganizationsUpdateCmekSettingsRequest(_messages.Message): r"""A LoggingOrganizationsUpdateCmekSettingsRequest object. Fields: cmekSettings: A CmekSettings resource to be passed as the request body. name: Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. updateMask: Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" """ cmekSettings = _messages.MessageField('CmekSettings', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingOrganizationsUpdateSettingsRequest(_messages.Message): r"""A LoggingOrganizationsUpdateSettingsRequest object. Fields: name: Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" settings: A Settings resource to be passed as the request body. updateMask: Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" """ name = _messages.StringField(1, required=True) settings = _messages.MessageField('Settings', 2) updateMask = _messages.StringField(3) class LoggingProjectsExclusionsCreateRequest(_messages.Message): r"""A LoggingProjectsExclusionsCreateRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. parent: Required. The parent resource in which to create the exclusion: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-logging-project" "organizations/123456789" """ logExclusion = _messages.MessageField('LogExclusion', 1) parent = _messages.StringField(2, required=True) class LoggingProjectsExclusionsDeleteRequest(_messages.Message): r"""A LoggingProjectsExclusionsDeleteRequest object. Fields: name: Required. The resource name of an existing exclusion to delete: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingProjectsExclusionsGetRequest(_messages.Message): r"""A LoggingProjectsExclusionsGetRequest object. Fields: name: Required. The resource name of an existing exclusion: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" """ name = _messages.StringField(1, required=True) class LoggingProjectsExclusionsListRequest(_messages.Message): r"""A LoggingProjectsExclusionsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose exclusions are to be listed. "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsExclusionsPatchRequest(_messages.Message): r"""A LoggingProjectsExclusionsPatchRequest object. Fields: logExclusion: A LogExclusion resource to be passed as the request body. name: Required. The resource name of the exclusion to update: "projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]" "organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]" "folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]" For example:"projects/my-project/exclusions/my-exclusion" updateMask: Required. A non-empty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of "filter,description". """ logExclusion = _messages.MessageField('LogExclusion', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingProjectsGetCmekSettingsRequest(_messages.Message): r"""A LoggingProjectsGetCmekSettingsRequest object. Fields: name: Required. The resource for which to retrieve CMEK settings. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can be configured for Google Cloud projects, folders, organizations, and billing accounts. Once configured for an organization, it applies to all projects and folders in the Google Cloud organization. """ name = _messages.StringField(1, required=True) class LoggingProjectsGetSettingsRequest(_messages.Message): r"""A LoggingProjectsGetSettingsRequest object. Fields: name: Required. The resource for which to retrieve settings. "projects/[PROJECT_ID]/settings" "organizations/[ORGANIZATION_ID]/settings" "billingAccounts/[BILLING_ACCOUNT_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings"Note: Settings can be retrieved for Google Cloud projects, folders, organizations, and billing accounts. """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsCreateAsyncRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsCreateAsyncRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsCreateRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsCreateRequest object. Fields: bucketId: 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. Bucket identifiers must start with an alphanumeric character. logBucket: A LogBucket resource to be passed as the request body. parent: Required. The resource in which to create the log bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" For example:"projects/my-project/locations/global" """ bucketId = _messages.StringField(1) logBucket = _messages.MessageField('LogBucket', 2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsDeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsDeleteRequest object. Fields: name: Required. The full resource name of the bucket to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsGetRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsGetRequest object. Fields: name: Required. The resource name of the bucket: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsLinksCreateRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsLinksCreateRequest object. Fields: link: A Link resource to be passed as the request body. linkId: 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: Required. The full resource name of the bucket to create a link for. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ link = _messages.MessageField('Link', 1) linkId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsLinksDeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsLinksDeleteRequest object. Fields: name: Required. The full resource name of the link to delete. "projects/[P ROJECT_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/[L OCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsLinksGetRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsLinksGetRequest object. Fields: name: Required. The resource name of the link: "projects/[PROJECT_ID]/loca tions/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" "organizations/ [ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LIN K_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buc kets/[BUCKET_ID]/links/[LINK_ID]" "folders/[FOLDER_ID]/locations/[LOCATI ON_ID]/buckets/[BUCKET_ID]/links/[LINK_ID]" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsLinksListRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsLinksListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. parent: Required. The parent resource whose links are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsListRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose buckets are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" Note: The locations portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all buckets. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsPatchRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsPatchRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingProjectsLocationsBucketsUndeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsUndeleteRequest object. Fields: name: Required. The full resource name of the bucket to undelete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" undeleteBucketRequest: A UndeleteBucketRequest resource to be passed as the request body. """ name = _messages.StringField(1, required=True) undeleteBucketRequest = _messages.MessageField('UndeleteBucketRequest', 2) class LoggingProjectsLocationsBucketsUpdateAsyncRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsUpdateAsyncRequest object. Fields: logBucket: A LogBucket resource to be passed as the request body. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ logBucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingProjectsLocationsBucketsViewsCreateRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsCreateRequest object. Fields: logView: A LogView resource to be passed as the request body. parent: Required. The bucket in which to create the view `"projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]"` For example:"projects/my-project/locations/global/buckets/my-bucket" viewId: Required. A client-assigned identifier such as "my-view". Identifiers are limited to 100 characters and can include only letters, digits, underscores, and hyphens. """ logView = _messages.MessageField('LogView', 1) parent = _messages.StringField(2, required=True) viewId = _messages.StringField(3) class LoggingProjectsLocationsBucketsViewsDeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsDeleteRequest object. Fields: name: Required. The full resource name of the view to delete: "projects/[P ROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsViewsGetIamPolicyRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsGetIamPolicyRequest object. Fields: getIamPolicyRequest: A GetIamPolicyRequest resource to be passed as the request body. resource: REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. """ getIamPolicyRequest = _messages.MessageField('GetIamPolicyRequest', 1) resource = _messages.StringField(2, required=True) class LoggingProjectsLocationsBucketsViewsGetRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsGetRequest object. Fields: name: Required. The resource name of the policy: "projects/[PROJECT_ID]/lo cations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsBucketsViewsListRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The bucket whose views are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsBucketsViewsLogsListRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingProjectsLocationsBucketsViewsPatchRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsPatchRequest object. Fields: logView: A LogView resource to be passed as the request body. name: Required. The full resource name of the view to update "projects/[PR OJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]" For example:"projects/my-project/locations/global/buckets/my- bucket/views/my-view" updateMask: Optional. Field mask that specifies the fields in view that need an update. A 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=filter """ logView = _messages.MessageField('LogView', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingProjectsLocationsBucketsViewsSetIamPolicyRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsSetIamPolicyRequest object. Fields: resource: REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) class LoggingProjectsLocationsBucketsViewsTestIamPermissionsRequest(_messages.Message): r"""A LoggingProjectsLocationsBucketsViewsTestIamPermissionsRequest object. Fields: resource: REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. testIamPermissionsRequest: A TestIamPermissionsRequest resource to be passed as the request body. """ resource = _messages.StringField(1, required=True) testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) class LoggingProjectsLocationsGetRequest(_messages.Message): r"""A LoggingProjectsLocationsGetRequest object. Fields: name: Resource name for the location. """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsListRequest(_messages.Message): r"""A LoggingProjectsLocationsListRequest object. Fields: extraLocationTypes: Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. filter: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160). name: The resource that owns the locations collection, if applicable. pageSize: The maximum number of results to return. If not set, the service selects a default. pageToken: A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page. """ extraLocationTypes = _messages.StringField(1, repeated=True) filter = _messages.StringField(2) name = _messages.StringField(3, required=True) pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) pageToken = _messages.StringField(5) class LoggingProjectsLocationsLogScopesCreateRequest(_messages.Message): r"""A LoggingProjectsLocationsLogScopesCreateRequest object. Fields: logScope: A LogScope resource to be passed as the request body. logScopeId: Required. A client-assigned identifier such as "log-scope". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods. First character has to be alphanumeric. parent: Required. The parent resource in which to create the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global" """ logScope = _messages.MessageField('LogScope', 1) logScopeId = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsLogScopesDeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsLogScopesDeleteRequest object. Fields: name: Required. The resource name of the log scope to delete: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsLogScopesGetRequest(_messages.Message): r"""A LoggingProjectsLocationsLogScopesGetRequest object. Fields: name: Required. The resource name of the log scope: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:"projects/my- project/locations/global/logScopes/my-log-scope" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsLogScopesListRequest(_messages.Message): r"""A LoggingProjectsLocationsLogScopesListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose log scopes are to be listed: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsLocationsLogScopesPatchRequest(_messages.Message): r"""A LoggingProjectsLocationsLogScopesPatchRequest object. Fields: logScope: A LogScope resource to be passed as the request body. name: Output only. The resource name of the log scope.Log scopes are only available in the global location. For example:projects/my- project/locations/global/logScopes/my-log-scope updateMask: Optional. Field mask that specifies the fields in log_scope that need an update. A 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=description """ logScope = _messages.MessageField('LogScope', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingProjectsLocationsOperationsApproveRedactionRequest(_messages.Message): r"""A LoggingProjectsLocationsOperationsApproveRedactionRequest object. Fields: name: Required. Name of the redaction operation.For example:"projects/my- project/locations/global/operations/my-operation" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsOperationsCancelRequest(_messages.Message): r"""A LoggingProjectsLocationsOperationsCancelRequest object. Fields: cancelOperationRequest: A CancelOperationRequest resource to be passed as the request body. name: The name of the operation resource to be cancelled. """ cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) name = _messages.StringField(2, required=True) class LoggingProjectsLocationsOperationsGetRequest(_messages.Message): r"""A LoggingProjectsLocationsOperationsGetRequest object. Fields: name: The name of the operation resource. """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsOperationsListRequest(_messages.Message): r"""A LoggingProjectsLocationsOperationsListRequest object. Fields: filter: The standard list filter. name: The name of the operation's parent resource. pageSize: The standard list page size. pageToken: The standard list page token. returnPartialSuccess: When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. """ filter = _messages.StringField(1) name = _messages.StringField(2, required=True) pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) pageToken = _messages.StringField(4) returnPartialSuccess = _messages.BooleanField(5) class LoggingProjectsLocationsRecentQueriesListRequest(_messages.Message): r"""A LoggingProjectsLocationsRecentQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") of the recent queries to list. The only valid value for this field is one of the two allowable type function calls, which are the following: type("Logging") type("OpsAnalytics") pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example:projects/my- project/locations/us-central1Note: The location portion of the resource must be specified, but supplying the character - in place of LOCATION_ID will return all recent queries. """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingProjectsLocationsSavedQueriesCreateRequest(_messages.Message): r"""A LoggingProjectsLocationsSavedQueriesCreateRequest object. Fields: parent: Required. The parent resource in which to create the saved query: "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/global" "organizations/123456789/locations/us- central1" savedQuery: A SavedQuery resource to be passed as the request body. savedQueryId: Optional. The ID to use for the saved query, which will become the final component of the saved query's resource name.If the saved_query_id is not provided, the system will generate an alphanumeric ID.The saved_query_id is 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. """ parent = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) savedQueryId = _messages.StringField(3) class LoggingProjectsLocationsSavedQueriesDeleteRequest(_messages.Message): r"""A LoggingProjectsLocationsSavedQueriesDeleteRequest object. Fields: name: Required. The full resource name of the saved query to delete. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsSavedQueriesGetRequest(_messages.Message): r"""A LoggingProjectsLocationsSavedQueriesGetRequest object. Fields: name: Required. The resource name of the saved query. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/savedQueries/[Q UERY_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/ savedQueries/[QUERY_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For example: "projects/my-project/locations/global/savedQueries/my- saved-query" """ name = _messages.StringField(1, required=True) class LoggingProjectsLocationsSavedQueriesListRequest(_messages.Message): r"""A LoggingProjectsLocationsSavedQueriesListRequest object. Fields: filter: Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED pageSize: Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my- project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingProjectsLocationsSavedQueriesPatchRequest(_messages.Message): r"""A LoggingProjectsLocationsSavedQueriesPatchRequest object. Fields: name: Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket- regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. savedQuery: A SavedQuery resource to be passed as the request body. updateMask: Required. A non-empty list of fields to change in the existing saved query. Fields are relative to the saved_query and new values for the fields are taken from the corresponding fields in the SavedQuery included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.To update all mutable fields, specify an update_mask of *.For example, to change the description and query filter text of a saved query, specify an update_mask of "description, query.filter". """ name = _messages.StringField(1, required=True) savedQuery = _messages.MessageField('SavedQuery', 2) updateMask = _messages.StringField(3) class LoggingProjectsLogsDeleteRequest(_messages.Message): r"""A LoggingProjectsLogsDeleteRequest object. Fields: logName: Required. The resource name of the log to delete: 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".For more information about log names, see LogEntry. """ logName = _messages.StringField(1, required=True) class LoggingProjectsLogsListRequest(_messages.Message): r"""A LoggingProjectsLogsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The resource name to list logs for: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID] resourceNames: Optional. List of resource names to list logs for: projects /[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID ] organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]/buckets/[BUCKE T_ID]/views/[VIEW_ID] billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] folders/[FOLDER_ID]/locat ions/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID]To support legacy queries, it could also be: projects/[PROJECT_ID] organizations/[ORGANIZATION_ID] billingAccounts/[BILLING_ACCOUNT_ID] folders/[FOLDER_ID]The resource name in the parent field is added to this list. """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) resourceNames = _messages.StringField(4, repeated=True) class LoggingProjectsMetricsCreateRequest(_messages.Message): r"""A LoggingProjectsMetricsCreateRequest object. Fields: logMetric: A LogMetric resource to be passed as the request body. parent: Required. The resource name of the project in which to create the metric: "projects/[PROJECT_ID]" The new metric must be provided in the request. """ logMetric = _messages.MessageField('LogMetric', 1) parent = _messages.StringField(2, required=True) class LoggingProjectsMetricsDeleteRequest(_messages.Message): r"""A LoggingProjectsMetricsDeleteRequest object. Fields: metricName: Required. The resource name of the metric to delete: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" """ metricName = _messages.StringField(1, required=True) class LoggingProjectsMetricsGetRequest(_messages.Message): r"""A LoggingProjectsMetricsGetRequest object. Fields: metricName: Required. The resource name of the desired metric: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" """ metricName = _messages.StringField(1, required=True) class LoggingProjectsMetricsListRequest(_messages.Message): r"""A LoggingProjectsMetricsListRequest object. Fields: pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The name of the project containing the metrics: "projects/[PROJECT_ID]" """ pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) pageToken = _messages.StringField(2) parent = _messages.StringField(3, required=True) class LoggingProjectsMetricsUpdateRequest(_messages.Message): r"""A LoggingProjectsMetricsUpdateRequest object. Fields: logMetric: A LogMetric resource to be passed as the request body. metricName: Required. The resource name of the metric to update: "projects/[PROJECT_ID]/metrics/[METRIC_ID]" The updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created. """ logMetric = _messages.MessageField('LogMetric', 1) metricName = _messages.StringField(2, required=True) class LoggingProjectsSinksCreateRequest(_messages.Message): r"""A LoggingProjectsSinksCreateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. parent: Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" uniqueWriterIdentity: Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account- types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) parent = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) class LoggingProjectsSinksDeleteRequest(_messages.Message): r"""A LoggingProjectsSinksDeleteRequest object. Fields: sinkName: Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingProjectsSinksGetRequest(_messages.Message): r"""A LoggingProjectsSinksGetRequest object. Fields: sinkName: Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingProjectsSinksListRequest(_messages.Message): r"""A LoggingProjectsSinksListRequest object. Fields: filter: Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingProjectsSinksPatchRequest(_messages.Message): r"""A LoggingProjectsSinksPatchRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingProjectsSinksUpdateRequest(_messages.Message): r"""A LoggingProjectsSinksUpdateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingQuery(_messages.Message): r"""Describes a Cloud Logging query that can be run in Logs Explorer UI or via the logging API.In addition to the query itself, additional information may be stored to capture the display configuration and other UI state used in association with analysis of query results. Fields: filter: 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. summaryFieldEnd: Characters will be counted from the end of the string. summaryFieldStart: Characters will be counted from the start of the string. summaryFields: Optional. The set of summary fields to display for this saved query. """ filter = _messages.StringField(1) summaryFieldEnd = _messages.IntegerField(2, variant=_messages.Variant.INT32) summaryFieldStart = _messages.IntegerField(3, variant=_messages.Variant.INT32) summaryFields = _messages.MessageField('SummaryField', 4, repeated=True) class LoggingSinksCreateRequest(_messages.Message): r"""A LoggingSinksCreateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. parent: Required. The resource in which to create the sink: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" For examples:"projects/my-project" "organizations/123456789" uniqueWriterIdentity: Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Cloud Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a service agent (https://cloud.google.com/iam/docs/service-account- types#service-agents) used by the sinks with the same parent. For more information, see writer_identity in LogSink. """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) parent = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) class LoggingSinksDeleteRequest(_messages.Message): r"""A LoggingSinksDeleteRequest object. Fields: sinkName: Required. The full resource name of the sink to delete, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingSinksGetRequest(_messages.Message): r"""A LoggingSinksGetRequest object. Fields: sinkName: Required. The resource name of the sink: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" """ sinkName = _messages.StringField(1, required=True) class LoggingSinksListRequest(_messages.Message): r"""A LoggingSinksListRequest object. Fields: filter: Optional. A filter expression to constrain the sinks returned. Today, this only supports the following strings: '' 'in_scope("ALL")', 'in_scope("ANCESTOR")', 'in_scope("DEFAULT")'.Description of scopes below. ALL: Includes all of the sinks which can be returned in any other scope. ANCESTOR: Includes intercepting sinks owned by ancestor resources. DEFAULT: Includes sinks owned by parent.When the empty string is provided, then the filter 'in_scope("DEFAULT")' is applied. pageSize: Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available. pageToken: Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call. parent: Required. The parent resource whose sinks are to be listed: "projects/[PROJECT_ID]" "organizations/[ORGANIZATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]" "folders/[FOLDER_ID]" """ filter = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) parent = _messages.StringField(4, required=True) class LoggingSinksUpdateRequest(_messages.Message): r"""A LoggingSinksUpdateRequest object. Fields: customWriterIdentity: Optional. The service account provided by the caller that will be used to write the log entries. The format must be serviceAccount:some@email. This field can only be specified when you are routing logs to a log bucket that is in a different project than the sink. When not specified, a Logging service account will automatically be generated. logSink: A LogSink resource to be passed as the request body. sinkName: Required. The full resource name of the sink to update, including the parent resource and the sink identifier: "projects/[PROJECT_ID]/sinks/[SINK_ID]" "organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]" "folders/[FOLDER_ID]/sinks/[SINK_ID]" For example:"projects/my- project/sinks/my-sink" uniqueWriterIdentity: Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field: If the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity. If the old value is false and the new value is true, then writer_identity is changed to a service agent (https://cloud.google.com/iam/docs/service-account-types#service-agents) owned by Cloud Logging. It is an error if the old value is true and the new value is set to false or defaulted to false. updateMask: Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes:destination,filter,includeChildrenAt some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol- buffers/docs/reference/google.protobuf#google.protobuf.FieldMaskFor example: updateMask=filter """ customWriterIdentity = _messages.StringField(1) logSink = _messages.MessageField('LogSink', 2) sinkName = _messages.StringField(3, required=True) uniqueWriterIdentity = _messages.BooleanField(4) updateMask = _messages.StringField(5) class LoggingUpdateCmekSettingsRequest(_messages.Message): r"""A LoggingUpdateCmekSettingsRequest object. Fields: cmekSettings: A CmekSettings resource to be passed as the request body. name: Required. The resource name for the CMEK settings to update. "projects/[PROJECT_ID]/cmekSettings" "organizations/[ORGANIZATION_ID]/cmekSettings" "billingAccounts/[BILLING_ACCOUNT_ID]/cmekSettings" "folders/[FOLDER_ID]/cmekSettings" For example:"organizations/12345/cmekSettings"Note: CMEK for the Log Router can currently only be configured for Google Cloud organizations. Once configured, it applies to all projects and folders in the Google Cloud organization. updateMask: Optional. Field mask identifying which fields from cmek_settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" """ cmekSettings = _messages.MessageField('CmekSettings', 1) name = _messages.StringField(2, required=True) updateMask = _messages.StringField(3) class LoggingUpdateSettingsRequest(_messages.Message): r"""A LoggingUpdateSettingsRequest object. Fields: name: Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" settings: A Settings resource to be passed as the request body. updateMask: Optional. Field mask identifying which fields from settings should be updated. A field will be overwritten if and only if it is in the update mask. Output only fields cannot be updated.See FieldMask for more information.For example: "updateMask=kmsKeyName" """ name = _messages.StringField(1, required=True) settings = _messages.MessageField('Settings', 2) updateMask = _messages.StringField(3) class MetricDescriptor(_messages.Message): r"""Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable. Enums: LaunchStageValueValuesEnum: Optional. The launch stage of the metric definition. MetricKindValueValuesEnum: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. ValueTypeValueValuesEnum: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. Fields: description: A detailed description of the metric, which can be used in documentation. displayName: 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: 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. The launch stage of the metric definition. metadata: Optional. Metadata which can be used to guide usage of the metric. metricKind: Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. monitoredResourceTypes: 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: The resource name of the metric descriptor. type: 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: 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: Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. """ class LaunchStageValueValuesEnum(_messages.Enum): r"""Optional. The launch stage of the metric definition. Values: LAUNCH_STAGE_UNSPECIFIED: Do not use this default value. UNIMPLEMENTED: The feature is not yet implemented. Users can not use it. PRELAUNCH: Prelaunch features are hidden from users and are only visible internally. EARLY_ACCESS: Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. ALPHA: Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. BETA: Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. GA: GA features are open to all developers and are considered stable and fully qualified for production use. DEPRECATED: Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation. """ LAUNCH_STAGE_UNSPECIFIED = 0 UNIMPLEMENTED = 1 PRELAUNCH = 2 EARLY_ACCESS = 3 ALPHA = 4 BETA = 5 GA = 6 DEPRECATED = 7 class MetricKindValueValuesEnum(_messages.Enum): r"""Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. Values: METRIC_KIND_UNSPECIFIED: Do not use this default value. GAUGE: An instantaneous measurement of a value. DELTA: The change in a value during a time interval. CUMULATIVE: A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points. """ METRIC_KIND_UNSPECIFIED = 0 GAUGE = 1 DELTA = 2 CUMULATIVE = 3 class ValueTypeValueValuesEnum(_messages.Enum): r"""Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. Values: VALUE_TYPE_UNSPECIFIED: Do not use this default value. BOOL: The value is a boolean. This value type can be used only if the metric kind is GAUGE. INT64: The value is a signed 64-bit integer. DOUBLE: The value is a double precision floating point number. STRING: The value is a text string. This value type can be used only if the metric kind is GAUGE. DISTRIBUTION: The value is a Distribution. MONEY: The value is money. """ VALUE_TYPE_UNSPECIFIED = 0 BOOL = 1 INT64 = 2 DOUBLE = 3 STRING = 4 DISTRIBUTION = 5 MONEY = 6 description = _messages.StringField(1) displayName = _messages.StringField(2) labels = _messages.MessageField('LabelDescriptor', 3, repeated=True) launchStage = _messages.EnumField('LaunchStageValueValuesEnum', 4) metadata = _messages.MessageField('MetricDescriptorMetadata', 5) metricKind = _messages.EnumField('MetricKindValueValuesEnum', 6) monitoredResourceTypes = _messages.StringField(7, repeated=True) name = _messages.StringField(8) type = _messages.StringField(9) unit = _messages.StringField(10) valueType = _messages.EnumField('ValueTypeValueValuesEnum', 11) class MetricDescriptorMetadata(_messages.Message): r"""Additional annotations that can be used to guide the usage of a metric. Enums: LaunchStageValueValuesEnum: Deprecated. Must use the MetricDescriptor.launch_stage instead. TimeSeriesResourceHierarchyLevelValueListEntryValuesEnum: Fields: ingestDelay: 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: Deprecated. Must use the MetricDescriptor.launch_stage instead. samplePeriod: 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. timeSeriesResourceHierarchyLevel: The scope of the timeseries data of the metric. """ class LaunchStageValueValuesEnum(_messages.Enum): r"""Deprecated. Must use the MetricDescriptor.launch_stage instead. Values: LAUNCH_STAGE_UNSPECIFIED: Do not use this default value. UNIMPLEMENTED: The feature is not yet implemented. Users can not use it. PRELAUNCH: Prelaunch features are hidden from users and are only visible internally. EARLY_ACCESS: Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. ALPHA: Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. BETA: Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. GA: GA features are open to all developers and are considered stable and fully qualified for production use. DEPRECATED: Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation. """ LAUNCH_STAGE_UNSPECIFIED = 0 UNIMPLEMENTED = 1 PRELAUNCH = 2 EARLY_ACCESS = 3 ALPHA = 4 BETA = 5 GA = 6 DEPRECATED = 7 class TimeSeriesResourceHierarchyLevelValueListEntryValuesEnum(_messages.Enum): r"""TimeSeriesResourceHierarchyLevelValueListEntryValuesEnum enum type. Values: TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED: Do not use this default value. PROJECT: Scopes a metric to a project. ORGANIZATION: Scopes a metric to an organization. FOLDER: Scopes a metric to a folder. """ TIME_SERIES_RESOURCE_HIERARCHY_LEVEL_UNSPECIFIED = 0 PROJECT = 1 ORGANIZATION = 2 FOLDER = 3 ingestDelay = _messages.StringField(1) launchStage = _messages.EnumField('LaunchStageValueValuesEnum', 2) samplePeriod = _messages.StringField(3) timeSeriesResourceHierarchyLevel = _messages.EnumField('TimeSeriesResourceHierarchyLevelValueListEntryValuesEnum', 4, repeated=True) class MonitoredResource(_messages.Message): r"""An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for "gce_instance" has labels "project_id", "instance_id" and "zone": { "type": "gce_instance", "labels": { "project_id": "my-project", "instance_id": "12345678901234", "zone": "us-central1-a" }} Messages: LabelsValue: 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". Fields: labels: 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: 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. """ @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""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". Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) labels = _messages.MessageField('LabelsValue', 1) type = _messages.StringField(2) class MonitoredResourceDescriptor(_messages.Message): r"""An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of "gce_instance" and specifies the use of the labels "instance_id" and "zone" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API. Enums: LaunchStageValueValuesEnum: Optional. The launch stage of the monitored resource definition. Fields: description: Optional. A detailed description of the monitored resource type that might be used in documentation. displayName: 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: 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. The launch stage of the monitored resource definition. name: 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: 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). """ class LaunchStageValueValuesEnum(_messages.Enum): r"""Optional. The launch stage of the monitored resource definition. Values: LAUNCH_STAGE_UNSPECIFIED: Do not use this default value. UNIMPLEMENTED: The feature is not yet implemented. Users can not use it. PRELAUNCH: Prelaunch features are hidden from users and are only visible internally. EARLY_ACCESS: Early Access features are limited to a closed group of testers. To use these features, you must sign up in advance and sign a Trusted Tester agreement (which includes confidentiality provisions). These features may be unstable, changed in backward-incompatible ways, and are not guaranteed to be released. ALPHA: Alpha is a limited availability test for releases before they are cleared for widespread use. By Alpha, all significant design issues are resolved and we are in the process of verifying functionality. Alpha customers need to apply for access, agree to applicable terms, and have their projects allowlisted. Alpha releases don't have to be feature complete, no SLAs are provided, and there are no technical support obligations, but they will be far enough along that customers can actually use them in test environments or for limited-use tests -- just like they would in normal production cases. BETA: Beta is the point at which we are ready to open a release for any customer to use. There are no SLA or technical support obligations in a Beta release. Products will be complete from a feature perspective, but may have some open outstanding issues. Beta releases are suitable for limited production use cases. GA: GA features are open to all developers and are considered stable and fully qualified for production use. DEPRECATED: Deprecated features are scheduled to be shut down and removed. For more information, see the "Deprecation Policy" section of our Terms of Service (https://cloud.google.com/terms/) and the Google Cloud Platform Subject to the Deprecation Policy (https://cloud.google.com/terms/deprecation) documentation. """ LAUNCH_STAGE_UNSPECIFIED = 0 UNIMPLEMENTED = 1 PRELAUNCH = 2 EARLY_ACCESS = 3 ALPHA = 4 BETA = 5 GA = 6 DEPRECATED = 7 description = _messages.StringField(1) displayName = _messages.StringField(2) labels = _messages.MessageField('LabelDescriptor', 3, repeated=True) launchStage = _messages.EnumField('LaunchStageValueValuesEnum', 4) name = _messages.StringField(5) type = _messages.StringField(6) class MonitoredResourceMetadata(_messages.Message): r"""Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. Messages: SystemLabelsValue: 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 } UserLabelsValue: Output only. A map of user-defined metadata labels. Fields: systemLabels: 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: Output only. A map of user-defined metadata labels. """ @encoding.MapUnrecognizedFields('additionalProperties') class SystemLabelsValue(_messages.Message): r"""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 } Messages: AdditionalProperty: An additional property for a SystemLabelsValue object. Fields: additionalProperties: Properties of the object. """ class AdditionalProperty(_messages.Message): r"""An additional property for a SystemLabelsValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class UserLabelsValue(_messages.Message): r"""Output only. A map of user-defined metadata labels. Messages: AdditionalProperty: An additional property for a UserLabelsValue object. Fields: additionalProperties: Additional properties of type UserLabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a UserLabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) systemLabels = _messages.MessageField('SystemLabelsValue', 1) userLabels = _messages.MessageField('UserLabelsValue', 2) class MoveBucketMetadata(_messages.Message): r"""Metadata for long running MoveBucket operations. Enums: StateValueValuesEnum: Output only. State of the operation. Fields: endTime: The end time of the operation. request: MoveBucket RPC request. startTime: The create time of the operation. state: Output only. State of the operation. """ class StateValueValuesEnum(_messages.Enum): r"""Output only. State of the operation. Values: OPERATION_STATE_UNSPECIFIED: Should not be used. OPERATION_STATE_SCHEDULED: The operation is scheduled. OPERATION_STATE_WAITING_FOR_PERMISSIONS: Waiting for necessary permissions. OPERATION_STATE_RUNNING: The operation is running. OPERATION_STATE_SUCCEEDED: The operation was completed successfully. OPERATION_STATE_FAILED: The operation failed. OPERATION_STATE_CANCELLED: The operation was cancelled by the user. OPERATION_STATE_PENDING: The operation is waiting for quota. """ OPERATION_STATE_UNSPECIFIED = 0 OPERATION_STATE_SCHEDULED = 1 OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2 OPERATION_STATE_RUNNING = 3 OPERATION_STATE_SUCCEEDED = 4 OPERATION_STATE_FAILED = 5 OPERATION_STATE_CANCELLED = 6 OPERATION_STATE_PENDING = 7 endTime = _messages.StringField(1) request = _messages.MessageField('MoveBucketRequest', 2) startTime = _messages.StringField(3) state = _messages.EnumField('StateValueValuesEnum', 4) class MoveBucketRequest(_messages.Message): r"""The parameters to MoveBucket. Fields: name: Required. The full resource name of the source bucket to move. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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" newName: Required. The full resource name of the relocated bucket. """ name = _messages.StringField(1) newName = _messages.StringField(2) class MoveBucketResponse(_messages.Message): r"""The response from MoveBucket. Fields: bucket: The resulting bucket from the move action. """ bucket = _messages.MessageField('LogBucket', 1) class Operation(_messages.Message): r"""This resource represents a long-running operation that is the result of a network API call. Messages: MetadataValue: 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. ResponseValue: The normal, successful response of the operation. 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. Fields: done: 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: The error result of the operation in case of failure or cancellation. metadata: 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: 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: The normal, successful response of the operation. 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. """ @encoding.MapUnrecognizedFields('additionalProperties') class MetadataValue(_messages.Message): r"""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. Messages: AdditionalProperty: An additional property for a MetadataValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a MetadataValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) @encoding.MapUnrecognizedFields('additionalProperties') class ResponseValue(_messages.Message): r"""The normal, successful response of the operation. 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. Messages: AdditionalProperty: An additional property for a ResponseValue object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a ResponseValue object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) done = _messages.BooleanField(1) error = _messages.MessageField('Status', 2) metadata = _messages.MessageField('MetadataValue', 3) name = _messages.StringField(4) response = _messages.MessageField('ResponseValue', 5) class OpsAnalyticsQuery(_messages.Message): r"""Describes an analytics query that can be run in the Log Analytics page of Google Cloud console.Preview: This is a preview feature and may be subject to change before final release. Fields: queryBuilder: Optional. A logs analytics query builder, which is used to build the SQL query that is then executed. queryExecutionRules: Optional. The query execution rules for the query request. sqlQueryText: Required. A logs analytics SQL query, which generally follows BigQuery format.This is the SQL query that appears in the Log Analytics UI's query editor. """ queryBuilder = _messages.MessageField('QueryBuilderConfig', 1) queryExecutionRules = _messages.MessageField('OpsAnalyticsQueryExecutionRules', 2) sqlQueryText = _messages.StringField(3) class OpsAnalyticsQueryExecutionRules(_messages.Message): r"""Defines the query execution rules for a given Ops Analytics query. LINT.IfChange Fields: useReservedSlots: Optional. If use_reserved_slots is set, the user's query will run on their BigQuery reservation rather than slots managed by Cloud Observability. """ useReservedSlots = _messages.BooleanField(1) class Parameter(_messages.Message): r"""A parameter value to be applied to an aggregation. Fields: doubleValue: A floating-point parameter value. intValue: An integer parameter value. """ doubleValue = _messages.FloatField(1) intValue = _messages.IntegerField(2) class Policy(_messages.Message): r"""An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). Fields: bindings: Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy. etag: etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read- modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. version: Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies). """ bindings = _messages.MessageField('Binding', 1, repeated=True) etag = _messages.BytesField(2) version = _messages.IntegerField(3, variant=_messages.Variant.INT32) class ProjectedField(_messages.Message): r"""Represents a field selected in the query, analogous to an item in a SQL SELECT clause. It specifies the source field and optionally applies transformations like aggregation, casting, regex extraction, or assigns an alias. Use ProjectedField when you need more than just the raw source field name (for which you might use FieldSource directly in QueryBuilderConfig's field_sources list if no transformations or specific operation type are needed). Enums: OperationValueValuesEnum: Specifies the role of this field (direct selection, grouping, or aggregation). Fields: aggregationFunction: The aggregation function for the field. alias: The alias name for the field. Valid alias examples are: - single word alias: TestAlias - numbers in an alias: Alias123 - multi word alias should be enclosed in quotes: "Test Alias" Invalid alias examples are: - alias containing keywords: WHERE, SELECT, FROM, etc. - alias starting with a number: 1stAlias cast: The cast for the field. This can any SQL cast type. Examples: - STRING - CHAR - DATE - TIMESTAMP - DATETIME - INT - FLOAT field: The field name. This will be the field that is selected using the dot notation to display the drill down value. operation: Specifies the role of this field (direct selection, grouping, or aggregation). regexExtraction: The re2 extraction for the field. This will be used to extract the value from the field using REGEXP_EXTRACT. More information on re2 can be found here: https://github.com/google/re2/wiki/Syntax. Meta characters like +?()| will need to be escaped. Examples: - ".(autoscaler.*)$" will be converted to REGEXP_EXTRACT(JSON_VALUE(field),"request(.*(autoscaler.*)$)")in SQL. - "\(test_value\)$" will be converted to REGEXP_EXTRACT(JSON_VALUE(field),"request(\(test_value\)$)") in SQL. sqlAggregationFunction: The function to apply to the field. truncationGranularity: The truncation granularity when grouping by a time/date field. This will be used to truncate the field to the granularity specified. This can be either a date or a time granularity found at https://cloud.google.com/bigquery/docs/reference/standard- sql/timestamp_functions#timestamp_trunc_granularity_date and https://cloud.google.com/bigquery/docs/reference/standard- sql/timestamp_functions#timestamp_trunc_granularity_time respectively. """ class OperationValueValuesEnum(_messages.Enum): r"""Specifies the role of this field (direct selection, grouping, or aggregation). Values: FIELD_OPERATION_UNSPECIFIED: Invalid value. Operation must be specified. NO_SETTING: Select the field directly without grouping or aggregation. Corresponds to including the raw field (potentially with cast, regex, or alias) in the SELECT list. GROUP_BY: Group the query results by the distinct values of this field. Corresponds to including the field (potentially truncated) in the GROUP BY clause. AGGREGATE: Apply an aggregation function to this field across grouped results. Corresponds to applying a function like COUNT, SUM, AVG in the SELECT list. Requires aggregation_function to be set. """ FIELD_OPERATION_UNSPECIFIED = 0 NO_SETTING = 1 GROUP_BY = 2 AGGREGATE = 3 aggregationFunction = _messages.MessageField('QueryStepAggregation', 1) alias = _messages.StringField(2) cast = _messages.StringField(3) field = _messages.StringField(4) operation = _messages.EnumField('OperationValueValuesEnum', 5) regexExtraction = _messages.StringField(6) sqlAggregationFunction = _messages.MessageField('FunctionApplication', 7) truncationGranularity = _messages.StringField(8) class QueryBuilderConfig(_messages.Message): r"""Defines a structured query configuration that can be used instead of writing raw SQL. This configuration represents the components of a SQL query (FROM, SELECT, WHERE, ORDER BY, LIMIT) and is typically converted into an executable query (e.g., BigQuery SQL) by the backend service to retrieve data for analysis or visualization. Fields: fieldSources: Defines the items to include in the query result, analogous to a SQL SELECT clause. fields: The fields to select in the query. This equates to the SELECT clause in SQL. filter: The filter to use for the query. This equates to the WHERE clause in SQL. limit: The limit to use for the query. This equates to the LIMIT clause in SQL. A limit of 0 will be treated as not enabled. orderBys: The sort orders to use for the query. This equates to the ORDER BY clause in SQL. resourceNames: Required. The view/resource to query. For now only a single view/resource will be sent, but there are plans to allow multiple views in the future. Marking as repeated for that purpose. Example: - "projects/123/locations/global/buckets/456/views/_Default" - "projects/123/locations/global/metricBuckets/456/views/_Default" searchTerm: The plain text search to use for the query. There is no support for multiple search terms. This uses the SEARCH functionality in BigQuery. For example, a search_term = 'ERROR' would result in the following SQL:SELECT * FROM resource WHERE SEARCH(resource, 'ERROR') LIMIT 100 """ fieldSources = _messages.MessageField('FieldSource', 1, repeated=True) fields = _messages.MessageField('ProjectedField', 2, repeated=True) filter = _messages.MessageField('FilterPredicate', 3) limit = _messages.IntegerField(4) orderBys = _messages.MessageField('SortOrderParameter', 5, repeated=True) resourceNames = _messages.StringField(6, repeated=True) searchTerm = _messages.StringField(7) class QueryBuilderQueryStep(_messages.Message): r"""A query step that builds an Analytics query from a query builder. Fields: parameters: Optional. Parameters to be injected into the query at execution time. queryBuilder: Required. The query builder to use. This is a proto containing a query builder definition that will be converted to BigQuery SQL syntax. queryRestriction: Optional. Restrictions being requested, e.g. timerange restrictions. """ parameters = _messages.MessageField('QueryParameter', 1, repeated=True) queryBuilder = _messages.MessageField('QueryBuilderConfig', 2) queryRestriction = _messages.MessageField('QueryRestriction', 3) class QueryDataLocalRequest(_messages.Message): r"""The request message for QueryDataLocal. This is identical to QueryDataRequest except for the associated resources. Messages: LabelsValue: Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa-client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. Fields: clientId: Optional. An identifier for the client who sent this query. This should be the same (or one of a small number of values) for all queries sent by a given client such as "alerting" or "dashboard". It is propagated to metric labels in Monarch and becomes the value of the label goog-oa-client-id in the BigQuery Job. Best practice is for all clients to set this field. If not set, then "unknown-client" will be used.This value will be visible in BigQuery's INFORMATION_SCHEMA.JOBS table.FORMATTING: * BigQuery label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. disableQueryCaching: Optional. If set to true, turns off all query caching on both the Log Analytics and BigQuery sides. labels: Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa-client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. parent: Required. The project in which the query will be run. The calling user must have the bigquery.jobs.create and bigquery.jobs.get permissions in this project.For example: "projects/PROJECT_ID" query: Required. The contents of the query. timeout: Optional. The timeout for the query. BigQuery will terminate the job if this duration is exceeded. If not set, the default is 5 minutes. """ @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa- client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) clientId = _messages.StringField(1) disableQueryCaching = _messages.BooleanField(2) labels = _messages.MessageField('LabelsValue', 3) parent = _messages.StringField(4) query = _messages.MessageField('AnalyticsQuery', 5) timeout = _messages.StringField(6) class QueryDataRequest(_messages.Message): r"""The parameters to QueryData. Messages: LabelsValue: Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa-client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. Fields: clientId: Optional. An identifier for the client who sent this query. This should be the same (or one of a small number of values) for all queries sent by a given client such as "alerting" or "dashboard". It is propagated to metric labels in Monarch and becomes the value of the label goog-oa-client-id in the BigQuery Job. Best practice is for all clients to set this field. If not set, then "unknown-client" will be used.This value will be visible in BigQuery's INFORMATION_SCHEMA.JOBS table.FORMATTING: * BigQuery label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. disableQueryCaching: Optional. If set to true, turns off all query caching on both the Log Analytics and BigQuery sides. labels: Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa-client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. query: Optional. The contents of the query. If this field is populated, query_steps will be ignored. For QueryDataSync the query must consist of a single SqlQueryStep. resourceNames: Required. Names of one or more views to run a SQL query.Example: projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BU CKET_ID]/views/[VIEW_ID]Requires appropriate permissions on each resource, such as 'logging.views.access' on log view resources.Alternatively, may be the name of a single project from which a slot reservation should be used. In this case, the SQL query is run against customer owned datasets. Any linked dataset referenced by the corresponding log view in the SQL query requires the logging.buckets.listLinks permission on the bucket owning the view.Example: projects/[PROJECT_ID] timeout: Optional. For queries made through QueryData, query will be terminated if it is not completed by the time this duration is exceeded. If not set, the default is 5 minutes. """ @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""Optional. A set of labels to be propagated to the BigQuery Job. If a resource generated the query, best practice is to provide sufficient labels to identify the resource. For example, alerting queries apply the label goog-alert-policy-id=12345678.Label keys and values will be visible to customers in BigQuery's INFORMATION_SCHEMA.JOBS table.The key goog-oa- client-id is reserved and should not be set. If set, the label's value will be silently overwritten.FORMATTING: * BigQuery key and label values can be no longer than 63 characters. They can only contain lowercase letters, numeric characters, underscores and dashes. Spaces are not allowed. Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) clientId = _messages.StringField(1) disableQueryCaching = _messages.BooleanField(2) labels = _messages.MessageField('LabelsValue', 3) query = _messages.MessageField('AnalyticsQuery', 4) resourceNames = _messages.StringField(5, repeated=True) timeout = _messages.StringField(6) class QueryDataResponse(_messages.Message): r"""The response data from QueryData. Fields: queryStepHandles: Handles to each of the query steps described in the request, excluding those for which the output_not_required flag was set. These may be passed to ReadQueryResults or used in a HandleQueryStep in a subsequent call to QueryData. resourceNames: The Cloud Logging resources that were used while serving the request, e.g. projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/ [BUCKET_ID]/views/[VIEW_ID] for any Views read or projects/[PROJECT_ID]/ locations/[LOCATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID] for any Links for any linked dataset resolved. restrictionConflicts: Conflicts between the query and the restrictions that were requested. Any restrictions present here were ignored when executing the query. """ queryStepHandles = _messages.StringField(1, repeated=True) resourceNames = _messages.StringField(2, repeated=True) restrictionConflicts = _messages.MessageField('QueryRestrictionConflict', 3, repeated=True) class QueryParameter(_messages.Message): r"""A parameter given to a query. Fields: description: Optional. Human-oriented description of the field. intArray: The value of a parameter containing an array of integers. intValue: Optional. The value of an integer parameter. name: Optional. If unset, this is a positional parameter. Otherwise, should be unique within a query. stringArray: The value of a parameter containing an array of strings. stringValue: Optional. The value of a string parameter. """ description = _messages.StringField(1) intArray = _messages.MessageField('IntegerArrayValue', 2) intValue = _messages.IntegerField(3) name = _messages.StringField(4) stringArray = _messages.MessageField('StringArrayValue', 5) stringValue = _messages.StringField(6) class QueryRestriction(_messages.Message): r"""Specifies query restrictions to apply. This allows UI to provide common filter needs (e.g. timestamps) without having the user to write them in SQL. Fields: receiveTimerange: Optional. This restriction is a TIME_RANGE restriction type in the QueryRestrictionConflict based on the receive_timestamp log field. Range is [start_time, end_time). Granularity: down to milliseconds (not nanoseconds)Note: This restriction also includes a 15 minute buffer on either side of the timerange on the timestamp column. timerange: Optional. This restriction is the TIME_RANGE restriction type in the QueryRestrictionConflict based on the primary timestamp column (ex. 'timestamp' for log entries, 'start_time' for spans). Range is [start_time, end_time). Granularity: down to milliseconds (not nanoseconds) """ receiveTimerange = _messages.MessageField('Interval', 1) timerange = _messages.MessageField('Interval', 2) class QueryRestrictionConflict(_messages.Message): r"""A conflict within a query that prevents applying restrictions. For instance, if the query contains a timestamp, this conflicts with timestamp restrictions e.g. time picker settings. Enums: ConfidenceValueValuesEnum: How confident the detector is that the restriction would cause a conflict. TypeValueValuesEnum: Specifies what conflict is present. Currently, this only supports timerange. Fields: column: One-based column number where the conflict was detected within the query. confidence: How confident the detector is that the restriction would cause a conflict. line: One-based line number where the conflict was detected within the query. type: Specifies what conflict is present. Currently, this only supports timerange. """ class ConfidenceValueValuesEnum(_messages.Enum): r"""How confident the detector is that the restriction would cause a conflict. Values: CONFIDENCE_UNSPECIFIED: Invalid. CERTAIN: If set, the query would be adversely affected by applying the restriction. UNCERTAIN: If set, the Query used a column being restricted, but might not be adversely affected. """ CONFIDENCE_UNSPECIFIED = 0 CERTAIN = 1 UNCERTAIN = 2 class TypeValueValuesEnum(_messages.Enum): r"""Specifies what conflict is present. Currently, this only supports timerange. Values: RESTRICTION_TYPE_UNSPECIFIED: Invalid. TIME_RANGE: This type means that the query conflicts with the time range restriction, e.g. query used the timestamp column to filter. JOIN: This type means that the query conflicts with a join restriction, meaning the query is using the JOIN operator.JOIN is important to detect for Ops Analytics Alerting queries because we want to prevent users from using potentially expensive JOIN based queries. LIMIT: This type means that the query conflicts with a limit restriction, meaning the query is using the LIMIT clause.LIMIT detection is going to be used for Ops Analytics Alerting hints towards the user to steer them away from including LIMIT in their queries. CUSTOMER_PROJECT_SLOT_RESERVATION: This type means that there is no active slot reservation that can be used to execute the query in the "local" mode in the customer's project. BQ_NATIVE_TABLE: This type means that the query's SELECT statement contains at least one native BigQuery table: a BigQuery table that that is not an Observability View. Presence of a native table in a query conflicts with the timepicker in the UI. Native tables' schemas are controlled by the users, and thus we do not know how to properly apply time restrictions to those tables. NO_VALID_TIMESTAMP_COLUMNS: Indicates that none of the views in the query have a valid timestamp column. This should cause the timepicker to be disabled. There are no row or columns associated with this conflict type. All bucketed views (Log, Trace, and Metrics views) have a valid timestamp. Analytics views must have a column named timestamp of type timestamp, non-repeated to be considered as having a valid timestamp column. RECEIVE_TIME_RANGE: This type means that the query conflicts with the receive_timerange restriction, e.g. query used the receive_timestamp field to filter. """ RESTRICTION_TYPE_UNSPECIFIED = 0 TIME_RANGE = 1 JOIN = 2 LIMIT = 3 CUSTOMER_PROJECT_SLOT_RESERVATION = 4 BQ_NATIVE_TABLE = 5 NO_VALID_TIMESTAMP_COLUMNS = 6 RECEIVE_TIME_RANGE = 7 column = _messages.IntegerField(1, variant=_messages.Variant.INT32) confidence = _messages.EnumField('ConfidenceValueValuesEnum', 2) line = _messages.IntegerField(3, variant=_messages.Variant.INT32) type = _messages.EnumField('TypeValueValuesEnum', 4) class QueryResults(_messages.Message): r"""Results of a SQL query over logs. Next ID: 18 Enums: BillingModelValueValuesEnum: Output only. The billing model used for this query. IndexUsageValueValuesEnum: The type of search index usage in the query. Messages: RowsValueListEntry: A RowsValueListEntry object. Fields: billingModel: Output only. The billing model used for this query. endTime: Output only. The end time of the query execution. Not set on validate queries. executionDuration: The total execution duration of the query. indexUsage: The type of search index usage in the query. jobLocation: The location where the query was executed. nextPageToken: A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. queryComplete: Whether the query has completed or not. If this is false, the rows, total_rows, and execution_time fields will not be populated. The client needs to poll on ReadQueryResults specifying the result_reference and wait for results. reservation: Output only. The resource name of the BigQuery reservation that this query was billed to, (or when validating, would be billed to). Only set when the billing model is USER_PROJECT_RESERVATION. If the billing model is USER_PROJECT_RESERVATION and this field is empty, then a reservation was required but not found, and the restriction_conflicts field will contain CUSTOMER_PROJECT_SLOT_RESERVATION.When set, the reservation name follows the standard resource name format: projects/[PR OJECT_ID]/locations/[LOCATION_ID]/reservations/[RESERVATION_ID] resourceNames: The resources that were used while serving the request, e.g. projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/v iews/[VIEW_ID] for any Views read or projects/[PROJECT_ID]/locations/[LO CATION_ID]/buckets/[BUCKET_ID]/links/[LINK_ID] for any Links for any linked dataset resolved. restrictionConflicts: Conflicts between the query and the restrictions that were requested. Any restrictions present here were ignored when executing the query. resultReference: An opaque string that can be used as a reference to this query result. This result reference can be used in the ReadQueryResults query to fetch this result up to 24 hours in the future.For QueryDataSync this is populated only if the query cannot be executed synchronously within the requested deadline. rows: Query result rows. The number of rows returned depends upon the page size requested. To get any additional rows, you can call ReadQueryResults and specify the result_reference and the page_token.The REST-based representation of this data leverages a series of JSON f,v objects for indicating fields and values. schema: The schema of the results. It shows the columns present in the output table. Present only when the query completes successfully. startTime: Output only. The start time of the query execution. Not set on validate queries. totalBytesProcessed: The total number of bytes processed for this query. If this query was a validate_only query, this is the number of bytes that would be processed if the query were run. totalRows: The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. totalSlotMs: The total slot-milliseconds consumed by this query. Populated only on a call to ReadQueryResults. """ class BillingModelValueValuesEnum(_messages.Enum): r"""Output only. The billing model used for this query. Values: BILLING_MODEL_UNSPECIFIED: The billing model is not specified. SYSTEM_BILLED: The query was billed to the system. USER_PROJECT_RESERVATION: The query was billed to the user's project using a reservation. USER_PROJECT_ON_DEMAND: The query was billed to the user's project using on-demand billing. USER_PROJECT_UNKNOWN_BILLING_MODEL: The query was to be billed to the user's project but the billing model could not be determined. This can happen when the query cannot be executed (or dry run) successfully. """ BILLING_MODEL_UNSPECIFIED = 0 SYSTEM_BILLED = 1 USER_PROJECT_RESERVATION = 2 USER_PROJECT_ON_DEMAND = 3 USER_PROJECT_UNKNOWN_BILLING_MODEL = 4 class IndexUsageValueValuesEnum(_messages.Enum): r"""The type of search index usage in the query. Values: INDEX_USAGE_UNSPECIFIED: The index usage is unknown. UNUSED: The query did not use any indexes. PARTIALLY_USED: Part of the query used search indexes. FULLY_USED: The entire query used search indexes. """ INDEX_USAGE_UNSPECIFIED = 0 UNUSED = 1 PARTIALLY_USED = 2 FULLY_USED = 3 @encoding.MapUnrecognizedFields('additionalProperties') class RowsValueListEntry(_messages.Message): r"""A RowsValueListEntry object. Messages: AdditionalProperty: An additional property for a RowsValueListEntry object. Fields: additionalProperties: Properties of the object. """ class AdditionalProperty(_messages.Message): r"""An additional property for a RowsValueListEntry object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) billingModel = _messages.EnumField('BillingModelValueValuesEnum', 1) endTime = _messages.StringField(2) executionDuration = _messages.StringField(3) indexUsage = _messages.EnumField('IndexUsageValueValuesEnum', 4) jobLocation = _messages.StringField(5) nextPageToken = _messages.StringField(6) queryComplete = _messages.BooleanField(7) reservation = _messages.StringField(8) resourceNames = _messages.StringField(9, repeated=True) restrictionConflicts = _messages.MessageField('QueryRestrictionConflict', 10, repeated=True) resultReference = _messages.StringField(11) rows = _messages.MessageField('RowsValueListEntry', 12, repeated=True) schema = _messages.MessageField('TableSchema', 13) startTime = _messages.StringField(14) totalBytesProcessed = _messages.IntegerField(15) totalRows = _messages.IntegerField(16) totalSlotMs = _messages.IntegerField(17) class QueryStep(_messages.Message): r"""One step of an analytics query. Each query step other than the first implicitly takes the output of the previous step as its input. Steps will be executed in sequence and will return their results independently (in other words, each step will finish at a different time and potentially return a different schema). Fields: alertingQueryStep: A query step that builds an alerting query from configuration data. chartingQueryStep: A query step that builds a charting query from configuration data. handleQueryStep: A query step that refers to a step within a previously- executed query. outputNotRequired: Optional. Set this flag to indicate that you don't intend to retrieve the results for this query step. No handle will be generated for the step in the QueryDataResponse message. queryBuilderQueryStep: A query step that builds a SQL query from a query builder. sqlQueryStep: A query step containing a SQL query. """ alertingQueryStep = _messages.MessageField('AlertingQueryStep', 1) chartingQueryStep = _messages.MessageField('ChartingQueryStep', 2) handleQueryStep = _messages.MessageField('HandleQueryStep', 3) outputNotRequired = _messages.BooleanField(4) queryBuilderQueryStep = _messages.MessageField('QueryBuilderQueryStep', 5) sqlQueryStep = _messages.MessageField('SqlQueryStep', 6) class QueryStepAggregation(_messages.Message): r"""An identifier for an aggregation. Aggregations are used for cases where we need to collapse a set of values into a single value, such as multiple points in a measure into a single bin. Fields: parameters: Optional. Parameters to be applied to the aggregation. Aggregations that support or require parameters are listed above. type: Required. The type of aggregation to apply. Legal values for this string are: "percentile" - Generates an APPROX_QUANTILES. Requires one integer or double parameter. Applies only to numeric values. Supports precision of up to 3 decimal places. "average" - Generates AVG(). Applies only to numeric values. "count" - Generates COUNT(). "count- distinct" - Generates COUNT(DISTINCT). "count-distinct-approx" - Generates APPROX_COUNT_DISTINCT(). "max" - Generates MAX(). Applies only to numeric values. "min" - Generates MIN(). Applies only to numeric values. "sum" - Generates SUM(). Applies only to numeric values. "or" - Generates LOGICAL_OR(). Applies only to boolean values. "and" - Generates LOGICAL_AND(). Applies only to boolean values. "none", "" - Equivalent to no aggregation. """ parameters = _messages.MessageField('Parameter', 1, repeated=True) type = _messages.StringField(2) class ReadQueryResultsRequest(_messages.Message): r"""Parameters to ReadQueryResults. Fields: clientId: Optional. An identifier for the client who sent this query. This should be the same (or one of a small number of values) for all queries sent by a given client such as Alerting or Dashboards. It is ultimately propagated to metric labels in Monarch. pageSize: Optional. The maximum number of rows to return in the results. Responses are limited to 10 MB in size.By default, there is no maximum row count, and only the byte limit applies. When the byte limit is reached, the rest of query results will be paginated. pageToken: Optional. Page token returned by a previous call to ReadQueryResults to paginate through the response rows. queryStepHandle: Required. A query step handle returned by QueryData. readMetadataOnly: Optional. If this flag is true, no rows will be returned regardless of the value of page_size; the rows and next_page_token members of the response will be empty. resourceNames: Required. Names of one or more views that were used in the original query.Example: projects/[PROJECT_ID]/locations/[LOCATION_ID]/bu ckets/[BUCKET_ID]/views/[VIEW_ID]Requires appropriate permissions on each resource such as 'logging.views.access' on log view resources. timeout: Optional. The maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. If this is not set, the call will return immediately with query_complete set to false. Otherwise, the call will block for the specified time and then return the state at that time. """ clientId = _messages.StringField(1) pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) pageToken = _messages.StringField(3) queryStepHandle = _messages.StringField(4) readMetadataOnly = _messages.BooleanField(5) resourceNames = _messages.StringField(6, repeated=True) timeout = _messages.StringField(7) class RecentQuery(_messages.Message): r"""Describes a recent query executed on the Logs Explorer or Log Analytics page within the last ~ 30 days. Fields: lastRunTime: Output only. The timestamp when this query was last run. loggingQuery: Logging query that can be executed in Logs Explorer or via Logging API. name: Output only. Resource name of the recent query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/recentQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support)The QUERY_ID is a system generated alphanumeric ID. opsAnalyticsQuery: Analytics query that can be executed in Log Analytics. """ lastRunTime = _messages.StringField(1) loggingQuery = _messages.MessageField('LoggingQuery', 2) name = _messages.StringField(3) opsAnalyticsQuery = _messages.MessageField('OpsAnalyticsQuery', 4) class RedactLogEntriesImpact(_messages.Message): r"""Information about the impact of a redaction. Fields: endTime: The time impact assessment was completed. logEntriesCount: The number of entries in the requested bucket that match the requested filter. sqlQuery: The equivalent SQL query to the Logging Query Language filter provided by the user. Only populated for analytics-enabled buckets. userApprovalTime: The time the user's approval of the impact assessment was received. Empty if the impact assessment has not yet finished or the user's approval has not yet been given. """ endTime = _messages.StringField(1) logEntriesCount = _messages.IntegerField(2) sqlQuery = _messages.StringField(3) userApprovalTime = _messages.StringField(4) class RedactLogEntriesMetadata(_messages.Message): r"""Metadata for RedactLogEntries long running operations. Enums: StateValueValuesEnum: Output only. State of an operation. Fields: cancellationRequested: Identifies whether the user has requested cancellation of the operation. endTime: The time at which the operation completed. impactAssessment: The expected impact of the operation. If not set, impact has not been fully assessed. progress: Estimated progress of the operation (0 - 100%). receiveTime: The time at which the redaction request was received. request: RedactLogEntries RPC request. startTime: The time at which redaction of log entries commenced. state: Output only. State of an operation. """ class StateValueValuesEnum(_messages.Enum): r"""Output only. State of an operation. Values: OPERATION_STATE_UNSPECIFIED: Should not be used. OPERATION_STATE_SCHEDULED: The operation is scheduled. OPERATION_STATE_WAITING_FOR_PERMISSIONS: Waiting for necessary permissions. OPERATION_STATE_RUNNING: The operation is running. OPERATION_STATE_SUCCEEDED: The operation was completed successfully. OPERATION_STATE_FAILED: The operation failed. OPERATION_STATE_CANCELLED: The operation was cancelled by the user. OPERATION_STATE_PENDING: The operation is waiting for quota. """ OPERATION_STATE_UNSPECIFIED = 0 OPERATION_STATE_SCHEDULED = 1 OPERATION_STATE_WAITING_FOR_PERMISSIONS = 2 OPERATION_STATE_RUNNING = 3 OPERATION_STATE_SUCCEEDED = 4 OPERATION_STATE_FAILED = 5 OPERATION_STATE_CANCELLED = 6 OPERATION_STATE_PENDING = 7 cancellationRequested = _messages.BooleanField(1) endTime = _messages.StringField(2) impactAssessment = _messages.MessageField('RedactLogEntriesImpact', 3) progress = _messages.IntegerField(4, variant=_messages.Variant.INT32) receiveTime = _messages.StringField(5) request = _messages.MessageField('RedactLogEntriesRequest', 6) startTime = _messages.StringField(7) state = _messages.EnumField('StateValueValuesEnum', 8) class RedactLogEntriesRequest(_messages.Message): r"""The parameters to RedactLogEntries. Fields: filter: Required. A filter specifying which log entries to redact. The filter must be no more than 20k characters. An empty filter matches all log entries. name: Required. Log bucket from which to redact log entries.For example:"projects/my-project/locations/global/buckets/my-source-bucket" reason: Required. The reason log entries need to be redacted. This field will be recorded in redacted log entries and should omit sensitive information. The reason is limited 1,024 characters. """ filter = _messages.StringField(1) name = _messages.StringField(2) reason = _messages.StringField(3) class RedactLogEntriesResponse(_messages.Message): r"""Response type for RedactLogEntries long running operations.""" class RequestLog(_messages.Message): r"""Complete log information about a single HTTP request to an App Engine application. Fields: appEngineRelease: App Engine release version. appId: Application that handled this request. cost: An indication of the relative cost of serving this request. endTime: Time when the request finished. finished: Whether this request is finished or active. first: 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: Internet host and port number of the resource being requested. httpVersion: HTTP version of request. Example: "HTTP/1.1". instanceId: An identifier for the instance that handled the request. instanceIndex: 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: Origin IP address. latency: Latency of the request. line: A list of log lines emitted by the application while serving this request. megaCycles: Number of CPU megacycles used to process request. method: Request method. Example: "GET", "HEAD", "PUT", "POST", "DELETE". moduleId: Module of the application that handled this request. nickname: 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: Time this request spent in the pending request queue. referrer: Referrer URL of request. requestId: 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: 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: Size in bytes sent back to client by request. sourceReference: 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: Stackdriver Trace span identifier for this request. startTime: Time when the request started. status: HTTP response status code. Example: 200, 404. taskName: Task name of the request, in the case of an offline request. taskQueueName: Queue name of the request, in the case of an offline request. traceId: Stackdriver Trace identifier for this request. traceSampled: If true, the value in the 'trace_id' field was sampled for storage in a trace backend. urlMapEntry: File or class that handled the request. userAgent: User agent that made the request. versionId: Version of the application that handled this request. wasLoadingRequest: Whether this was a loading request for the instance. """ appEngineRelease = _messages.StringField(1) appId = _messages.StringField(2) cost = _messages.FloatField(3) endTime = _messages.StringField(4) finished = _messages.BooleanField(5) first = _messages.BooleanField(6) host = _messages.StringField(7) httpVersion = _messages.StringField(8) instanceId = _messages.StringField(9) instanceIndex = _messages.IntegerField(10, variant=_messages.Variant.INT32) ip = _messages.StringField(11) latency = _messages.StringField(12) line = _messages.MessageField('LogLine', 13, repeated=True) megaCycles = _messages.IntegerField(14) method = _messages.StringField(15) moduleId = _messages.StringField(16) nickname = _messages.StringField(17) pendingTime = _messages.StringField(18) referrer = _messages.StringField(19) requestId = _messages.StringField(20) resource = _messages.StringField(21) responseSize = _messages.IntegerField(22) sourceReference = _messages.MessageField('SourceReference', 23, repeated=True) spanId = _messages.StringField(24) startTime = _messages.StringField(25) status = _messages.IntegerField(26, variant=_messages.Variant.INT32) taskName = _messages.StringField(27) taskQueueName = _messages.StringField(28) traceId = _messages.StringField(29) traceSampled = _messages.BooleanField(30) urlMapEntry = _messages.StringField(31) userAgent = _messages.StringField(32) versionId = _messages.StringField(33) wasLoadingRequest = _messages.BooleanField(34) class RowCountThreshold(_messages.Message): r"""A threshold condition that compares the row count to a threshold. Ex. COUNT(*) > 10 Fields: trigger: Optional. The number/percent of rows that must exceed the threshold in order for this result set (partition set) to be considered in violation. If unspecified, then the result set (partition set) will be in violation when a single row violates the threshold. """ trigger = _messages.MessageField('AlertingTrigger', 1) class SavedQuery(_messages.Message): r"""Describes a query that has been saved by a user. Enums: VisibilityValueValuesEnum: Required. The visibility status of this query, which determines its ownership. Fields: createTime: Output only. The timestamp when the saved query was created. description: Optional. A human readable description of the saved query. displayName: Required. The user specified title for the SavedQuery. loggingQuery: Logging query that can be executed in Logs Explorer or via Logging API. name: Output only. Resource name of the saved query.In the format: "projects/[PROJECT_ID]/locations/[LOCATION_ID]/savedQueries/[QUERY_ID]" For a list of supported locations, see Supported Regions (https://cloud.google.com/logging/docs/region-support#bucket- regions)After the saved query is created, the location cannot be changed.If the user doesn't provide a QUERY_ID, the system will generate an alphanumeric ID. opsAnalyticsQuery: Analytics query that can be executed in Log Analytics. updateTime: Output only. The timestamp when the saved query was last updated. visibility: Required. The visibility status of this query, which determines its ownership. """ class VisibilityValueValuesEnum(_messages.Enum): r"""Required. The visibility status of this query, which determines its ownership. Values: VISIBILITY_UNSPECIFIED: The saved query visibility is unspecified. A CreateSavedQuery request with an unspecified visibility will be rejected. PRIVATE: The saved query is only visible to the user that created it. SHARED: The saved query is visible to anyone in the project. """ VISIBILITY_UNSPECIFIED = 0 PRIVATE = 1 SHARED = 2 createTime = _messages.StringField(1) description = _messages.StringField(2) displayName = _messages.StringField(3) loggingQuery = _messages.MessageField('LoggingQuery', 4) name = _messages.StringField(5) opsAnalyticsQuery = _messages.MessageField('OpsAnalyticsQuery', 6) updateTime = _messages.StringField(7) visibility = _messages.EnumField('VisibilityValueValuesEnum', 8) class SetIamPolicyRequest(_messages.Message): r"""Request message for SetIamPolicy method. Fields: policy: REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them. updateMask: OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag" """ policy = _messages.MessageField('Policy', 1) updateMask = _messages.StringField(2) class Settings(_messages.Message): r"""Describes the settings associated with a project, folder, organization, or billing account. Enums: AnalyticsModeValueValuesEnum: Optional. The default analytics mode of an org or folder which is inherited by all newly created child project buckets. Fields: analyticsMode: Optional. The default analytics mode of an org or folder which is inherited by all newly created child project buckets. defaultSinkConfig: Optional. Overrides the built-in configuration for _Default sink. disableDefaultSink: 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 storage if there is already an aggregated sink configured in the hierarchy. The _Default sink can be re-enabled manually if needed. kmsKeyName: Optional. The resource name for the configured Cloud KMS key.KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/key Rings/[KEYRING]/cryptoKeys/[KEY]" For example:"projects/my- project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"To enable CMEK, 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.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: Output only. The service account that will be used by the Log Router to access your Cloud KMS key.Before enabling CMEK, you must first assign the role roles/cloudkms.cryptoKeyEncrypterDecrypter to the service account that will be used 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. loggingServiceAccountId: Output only. The service account for the given resource container, such as project or folder. Log sinks use this service account as their writer_identity if no custom service account is provided in the request when calling the create sink method. name: Output only. The resource name of the settings. storageLocation: Optional. The storage location for the _Default and _Required log buckets of newly created projects and folders, unless the storage location is explicitly provided.Example value: europe- west1.Note: this setting does not affect the location of resources where a location is explicitly provided when created, such as custom log buckets. """ class AnalyticsModeValueValuesEnum(_messages.Enum): r"""Optional. The default analytics mode of an org or folder which is inherited by all newly created child project buckets. Values: ANALYTICS_MODE_UNSPECIFIED: No default analytics mode defined at this resource level, it will inherit from the closest ancester which has a defined analytics mode. If there is no specified analytics mode across the resource hierarchy, analytics will be disabled by default. ANALYTICS_REQUIRED: By default, analytics will be enabled for all new project-level buckets, even if analytics_enabled is set to false during the creation request. ANALYTICS_OPTIONAL: By default, analytics will be disabled for new project-level buckets unless explicitly specified otherwise at bucket creation time. """ ANALYTICS_MODE_UNSPECIFIED = 0 ANALYTICS_REQUIRED = 1 ANALYTICS_OPTIONAL = 2 analyticsMode = _messages.EnumField('AnalyticsModeValueValuesEnum', 1) defaultSinkConfig = _messages.MessageField('DefaultSinkConfig', 2) disableDefaultSink = _messages.BooleanField(3) kmsKeyName = _messages.StringField(4) kmsServiceAccountId = _messages.StringField(5) loggingServiceAccountId = _messages.StringField(6) name = _messages.StringField(7) storageLocation = _messages.StringField(8) class SortOrderParameter(_messages.Message): r"""A sort order for a query based on a column. Enums: SortOrderDirectionValueValuesEnum: The sort order to use for the query. Fields: field: A string attribute. fieldSource: The field to sort on. Can be one of the FieldSource types: field name, alias ref, variable ref, or a literal value. sortOrderDirection: The sort order to use for the query. """ class SortOrderDirectionValueValuesEnum(_messages.Enum): r"""The sort order to use for the query. Values: SORT_ORDER_UNSPECIFIED: Invalid value, do not use. SORT_ORDER_NONE: No sorting will be applied. This is used to determine if the query is in pass thru mode. To correctly chart a query in pass thru mode, NONE will need to be sent SORT_ORDER_ASCENDING: The lowest-valued entries will be selected. SORT_ORDER_DESCENDING: The highest-valued entries will be selected. """ SORT_ORDER_UNSPECIFIED = 0 SORT_ORDER_NONE = 1 SORT_ORDER_ASCENDING = 2 SORT_ORDER_DESCENDING = 3 field = _messages.StringField(1) fieldSource = _messages.MessageField('FieldSource', 2) sortOrderDirection = _messages.EnumField('SortOrderDirectionValueValuesEnum', 3) class Sorting(_messages.Message): r"""Defines a sort order based on a column. There are different requirements for this message depending on its context; see the containing message for details. Enums: OrderValueValuesEnum: Optional. The order in which to sort. Fields: column: Optional. The column name on which to sort. order: Optional. The order in which to sort. """ class OrderValueValuesEnum(_messages.Enum): r"""Optional. The order in which to sort. Values: SORT_ORDER_UNSPECIFIED: Invalid value, do not use. SORT_ORDER_NONE: No sorting will be applied. SORT_ORDER_ASCENDING: The lowest-valued entries will be selected. SORT_ORDER_DESCENDING: The highest-valued entries will be selected. """ SORT_ORDER_UNSPECIFIED = 0 SORT_ORDER_NONE = 1 SORT_ORDER_ASCENDING = 2 SORT_ORDER_DESCENDING = 3 column = _messages.StringField(1) order = _messages.EnumField('OrderValueValuesEnum', 2) class SourceLocation(_messages.Message): r"""Specifies a location in a source code file. Fields: file: Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name. functionName: 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: Line within the source file. """ file = _messages.StringField(1) functionName = _messages.StringField(2) line = _messages.IntegerField(3) class SourceReference(_messages.Message): r"""A reference to a particular snapshot of the source tree used to build and deploy an application. Fields: repository: Optional. A URI string identifying the repository. Example: "https://github.com/GoogleCloudPlatform/kubernetes.git" revisionId: The canonical and persistent identifier of the deployed revision. Example (git): "0035781c50ec7aa23385dc841529ce8a4b70db1b" """ repository = _messages.StringField(1) revisionId = _messages.StringField(2) class SqlQueryStep(_messages.Message): r"""A query step defined in raw SQL. Fields: parameters: Optional. Parameters to be injected into the query at execution time. queryRestriction: Optional. Restrictions being requested, e.g. timerange restrictions. sqlQuery: Required. A query string, following the BigQuery SQL query syntax. The FROM clause should specify a fully qualified log view corresponding to the log view in the resource_names in dot separated format like PROJECT_ID.LOCATION_ID.BUCKET_ID.VIEW_ID.For example: SELECT count(*) FROM my_project.us.my_bucket._AllLogs;If any of the dot separated components have special characters, that component needs to be escaped separately like the following example:SELECT count(*) FROM company.com:abc.us.my-bucket._AllLogs; """ parameters = _messages.MessageField('QueryParameter', 1, repeated=True) queryRestriction = _messages.MessageField('QueryRestriction', 2) sqlQuery = _messages.StringField(3) class StandardQueryParameters(_messages.Message): r"""Query parameters accepted by all methods. Enums: FXgafvValueValuesEnum: V1 error format. AltValueValuesEnum: Data format for response. Fields: f__xgafv: V1 error format. access_token: OAuth access token. alt: Data format for response. callback: JSONP fields: Selector specifying which fields to include in a partial response. key: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. oauth_token: OAuth 2.0 token for the current user. prettyPrint: Returns response with indentations and line breaks. quotaUser: Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. trace: A tracing token of the form "token:" to include in api requests. uploadType: Legacy upload protocol for media (e.g. "media", "multipart"). upload_protocol: Upload protocol for media (e.g. "raw", "multipart"). """ class AltValueValuesEnum(_messages.Enum): r"""Data format for response. Values: json: Responses with Content-Type of application/json media: Media download with context-dependent Content-Type proto: Responses with Content-Type of application/x-protobuf """ json = 0 media = 1 proto = 2 class FXgafvValueValuesEnum(_messages.Enum): r"""V1 error format. Values: _1: v1 error format _2: v2 error format """ _1 = 0 _2 = 1 f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1) access_token = _messages.StringField(2) alt = _messages.EnumField('AltValueValuesEnum', 3, default='json') callback = _messages.StringField(4) fields = _messages.StringField(5) key = _messages.StringField(6) oauth_token = _messages.StringField(7) prettyPrint = _messages.BooleanField(8, default=True) quotaUser = _messages.StringField(9) trace = _messages.StringField(10) uploadType = _messages.StringField(11) upload_protocol = _messages.StringField(12) class Status(_messages.Message): r"""The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). Messages: DetailsValueListEntry: A DetailsValueListEntry object. Fields: code: The status code, which should be an enum value of google.rpc.Code. details: A list of messages that carry the error details. There is a common set of message types for APIs to use. message: 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. """ @encoding.MapUnrecognizedFields('additionalProperties') class DetailsValueListEntry(_messages.Message): r"""A DetailsValueListEntry object. Messages: AdditionalProperty: An additional property for a DetailsValueListEntry object. Fields: additionalProperties: Properties of the object. Contains field @type with type URL. """ class AdditionalProperty(_messages.Message): r"""An additional property for a DetailsValueListEntry object. Fields: key: Name of the additional property. value: A extra_types.JsonValue attribute. """ key = _messages.StringField(1) value = _messages.MessageField('extra_types.JsonValue', 2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) code = _messages.IntegerField(1, variant=_messages.Variant.INT32) details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True) message = _messages.StringField(3) class StringArrayValue(_messages.Message): r"""An array of strings within a parameter. Fields: values: Optional. The values of the array. """ values = _messages.StringField(1, repeated=True) class SummaryField(_messages.Message): r"""A field from the LogEntry that is added to the summary line (https://cloud.google.com/logging/docs/view/logs-explorer-interface#add- summary-fields) for a query in the Logs Explorer. Fields: field: Optional. The field from the LogEntry to include in the summary line, for example resource.type or jsonPayload.name. """ field = _messages.StringField(1) class SuppressionInfo(_messages.Message): r"""Information about entries that were omitted from the session. Enums: ReasonValueValuesEnum: The reason that entries were omitted from the session. Fields: reason: The reason that entries were omitted from the session. suppressedCount: A lower bound on the count of entries omitted due to reason. """ class ReasonValueValuesEnum(_messages.Enum): r"""The reason that entries were omitted from the session. Values: REASON_UNSPECIFIED: Unexpected default. RATE_LIMIT: Indicates suppression occurred due to relevant entries being received in excess of rate limits. For quotas and limits, see Logging API quotas and limits (https://cloud.google.com/logging/quotas#api- limits). NOT_CONSUMED: Indicates suppression occurred due to the client not consuming responses quickly enough. """ REASON_UNSPECIFIED = 0 RATE_LIMIT = 1 NOT_CONSUMED = 2 reason = _messages.EnumField('ReasonValueValuesEnum', 1) suppressedCount = _messages.IntegerField(2, variant=_messages.Variant.INT32) class TableFieldSchema(_messages.Message): r"""A field in TableSchema. The fields describe the static fields in the LogEntry. Any dynamic fields generated by the customer in fields like labels and jsonPayload are not listed in the schema as they use a native JSON type field. Fields: description: Optional. The field description. fields: Optional. Describes the nested schema fields if the type property is set to RECORD. mode: Optional. The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. name: Required. The field name corresponding to fields in the LogEntry. type: Required. The field data type. Possible values include: STRING BYTES INTEGER (or INT64) FLOAT (or FLOAT64) BOOLEAN (or BOOL) TIMESTAMP DATE TIME DATETIME GEOGRAPHY NUMERIC BIGNUMERIC JSON RECORD (or STRUCT) RANGE (Preview)Use of RECORD/STRUCT indicates that the field contains a nested schema. """ description = _messages.StringField(1) fields = _messages.MessageField('TableFieldSchema', 2, repeated=True) mode = _messages.StringField(3) name = _messages.StringField(4) type = _messages.StringField(5) class TableSchema(_messages.Message): r"""Schema of a table containing logs. Fields: fields: Output only. Describes the fields in a table. """ fields = _messages.MessageField('TableFieldSchema', 1, repeated=True) class TailLogEntriesRequest(_messages.Message): r"""The parameters to TailLogEntries. Fields: bufferWindow: 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. 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: 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/[LOC ATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] organizations/[ORGANIZATIO N_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]/views/[VIEW_ID] billin gAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_I D]/views/[VIEW_ID] folders/[FOLDER_ID]/locations/[LOCATION_ID]/buckets/[ BUCKET_ID]/views/[VIEW_ID] """ bufferWindow = _messages.StringField(1) filter = _messages.StringField(2) resourceNames = _messages.StringField(3, repeated=True) class TailLogEntriesResponse(_messages.Message): r"""Result returned from TailLogEntries. Fields: entries: 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: 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. """ entries = _messages.MessageField('LogEntry', 1, repeated=True) suppressionInfo = _messages.MessageField('SuppressionInfo', 2, repeated=True) class TestIamPermissionsRequest(_messages.Message): r"""Request message for TestIamPermissions method. Fields: permissions: The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions). """ permissions = _messages.StringField(1, repeated=True) class TestIamPermissionsResponse(_messages.Message): r"""Response message for TestIamPermissions method. Fields: permissions: A subset of TestPermissionsRequest.permissions that the caller is allowed. """ permissions = _messages.StringField(1, repeated=True) class UndeleteBucketRequest(_messages.Message): r"""The parameters to UndeleteBucket.""" class UpdateBucketRequest(_messages.Message): r"""The parameters to UpdateBucket. Fields: bucket: Required. The updated bucket. name: Required. The full resource name of the bucket to update. "projects/[PROJECT_ID]/locations/[LOCATION_ID]/buckets/[BUCKET_ID]" "org anizations/[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: 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 """ bucket = _messages.MessageField('LogBucket', 1) name = _messages.StringField(2) updateMask = _messages.StringField(3) class ValidateQueryResponse(_messages.Message): r"""The response data from ValidateQuery. Fields: validateResult: The operation does basic syntactic validation on all steps and will return an error if an issue is found. Only the first query step is validated through BigQuery, however, and only if it's a SqlQueryStep. If the first step is not SQL, this field will be empty. """ validateResult = _messages.MessageField('QueryResults', 1) class ValueThreshold(_messages.Message): r"""A threshold condition that compares a value to a threshold. Fields: trigger: Optional. The number/percent of rows that must exceed the threshold in order for this result set (partition set) to be considered in violation. If unspecified, then the result set (partition set) will be in violation when a single row violates the threshold. valueColumn: Required. The column to compare the threshold against. """ trigger = _messages.MessageField('AlertingTrigger', 1) valueColumn = _messages.StringField(2) class WriteLogEntriesRequest(_messages.Message): r"""The parameters to WriteLogEntries. Messages: LabelsValue: 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. Fields: dryRun: 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: 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. 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. 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. 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. 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. """ @encoding.MapUnrecognizedFields('additionalProperties') class LabelsValue(_messages.Message): r"""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. Messages: AdditionalProperty: An additional property for a LabelsValue object. Fields: additionalProperties: Additional properties of type LabelsValue """ class AdditionalProperty(_messages.Message): r"""An additional property for a LabelsValue object. Fields: key: Name of the additional property. value: A string attribute. """ key = _messages.StringField(1) value = _messages.StringField(2) additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) dryRun = _messages.BooleanField(1) entries = _messages.MessageField('LogEntry', 2, repeated=True) labels = _messages.MessageField('LabelsValue', 3) logName = _messages.StringField(4) partialSuccess = _messages.BooleanField(5) resource = _messages.MessageField('MonitoredResource', 6) class WriteLogEntriesResponse(_messages.Message): r"""Result returned from WriteLogEntries.""" encoding.AddCustomJsonFieldMapping( StandardQueryParameters, 'f__xgafv', '$.xgafv') encoding.AddCustomJsonEnumMapping( StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1') encoding.AddCustomJsonEnumMapping( StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')