"""Generated message classes for observability version v1.

Provides functionality for configuring the observability scope, which controls
the log, metric, and trace data that you can view.
"""
# NOTE: This file is autogenerated and should not be edited by hand.

from apitools.base.protorpclite import messages as _messages
from apitools.base.py import encoding
from apitools.base.py import extra_types


package = 'observability'


class Bucket(_messages.Message):
  r"""Bucket configuration for storing observability data.

  Fields:
    cmekSettings: Optional. Settings for configuring CMEK on a bucket.
    createTime: Output only. Create timestamp.
    deleteTime: Output only. Delete timestamp.
    description: Optional. Description of the bucket.
    displayName: Optional. User friendly display name.
    name: Identifier. Name of the bucket. The format is:
      projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
    purgeTime: Output only. Timestamp when the bucket in soft-deleted state is
      purged.
    updateTime: Output only. Update timestamp.
  """

  cmekSettings = _messages.MessageField('CmekSettings', 1)
  createTime = _messages.StringField(2)
  deleteTime = _messages.StringField(3)
  description = _messages.StringField(4)
  displayName = _messages.StringField(5)
  name = _messages.StringField(6)
  purgeTime = _messages.StringField(7)
  updateTime = _messages.StringField(8)


class CancelOperationRequest(_messages.Message):
  r"""The request message for Operations.CancelOperation."""


class CmekSettings(_messages.Message):
  r"""Settings for configuring CMEK for a bucket.

  Fields:
    kmsKey: Optional. The resource name for the configured Cloud KMS key. The
      format is: projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]
      /cryptoKeys/[KEY] For example: projects/my-project/locations/us-
      central1/keyRings/my-ring/cryptoKeys/my-key
    kmsKeyVersion: Output only. The CryptoKeyVersion resource name for the
      configured Cloud KMS key. The format is: projects/[PROJECT_ID]/locations
      /[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]/cryptoKeyVersions/[VERSI
      ON] For example: projects/my-project/locations/us-central1/keyRings/my-
      ring/cryptoKeys/my-key/cryptoKeyVersions/1 This read-only field is used
      to convey the specific configured CryptoKeyVersion of the `kms_key` that
      has been configured. It is populated when the CMEK settings are bound to
      a single key version.
    serviceAccountId: Output only. The service account used to access the key.
  """

  kmsKey = _messages.StringField(1)
  kmsKeyVersion = _messages.StringField(2)
  serviceAccountId = _messages.StringField(3)


class Dataset(_messages.Message):
  r"""A dataset is a collection of data that has a specific configuration. A
  dataset can be backed by multiple tables. One bucket can have multiple
  datasets.

  Fields:
    createTime: Output only. Create timestamp.
    deleteTime: Output only. Delete timestamp.
    description: Optional. Description of the dataset.
    displayName: Optional. User friendly display name.
    name: Identifier. Name of the dataset. The format is: projects/[PROJECT_ID
      ]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]
    purgeTime: Output only. Timestamp when the dataset in soft-deleted state
      is purged.
  """

  createTime = _messages.StringField(1)
  deleteTime = _messages.StringField(2)
  description = _messages.StringField(3)
  displayName = _messages.StringField(4)
  name = _messages.StringField(5)
  purgeTime = _messages.StringField(6)


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 Link(_messages.Message):
  r"""A link lets a dataset be accessible to BigQuery via usage of linked
  datasets.

  Fields:
    createTime: Output only. Create timestamp.
    description: Optional. Description of the link.
    displayName: Optional. A user friendly display name.
    name: Identifier. Name of the link. The format is: projects/[PROJECT_ID]/l
      ocations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LIN
      K_ID]
  """

  createTime = _messages.StringField(1)
  description = _messages.StringField(2)
  displayName = _messages.StringField(3)
  name = _messages.StringField(4)


class ListBucketsResponse(_messages.Message):
  r"""Response for listing buckets.

  Fields:
    buckets: Optional. The list of buckets.
    nextPageToken: Optional. A token that can be sent as `page_token` to
      retrieve the next page. When this field is omitted, there are no
      subsequent pages.
  """

  buckets = _messages.MessageField('Bucket', 1, repeated=True)
  nextPageToken = _messages.StringField(2)


class ListDatasetsResponse(_messages.Message):
  r"""Response for listing datasets.

  Fields:
    datasets: The list of datasets.
    nextPageToken: A token that can be sent as `page_token` to retrieve the
      next page. When this field is omitted, there are no subsequent pages.
  """

  datasets = _messages.MessageField('Dataset', 1, repeated=True)
  nextPageToken = _messages.StringField(2)


class ListLinksResponse(_messages.Message):
  r"""Response for listing links.

  Fields:
    links: The list of links.
    nextPageToken: Optional. A token that can be sent as `page_token` to
      retrieve the next page. When this field is omitted, there are no
      subsequent pages.
  """

  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 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. For example, 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 ListTraceScopesResponse(_messages.Message):
  r"""Response for listing TraceScopes.

  Fields:
    nextPageToken: Optional. If there might be more results than appear in
      this response, then `next_page_token` is included. To get the next set
      of results, call the same method again using the value of
      `next_page_token` as `page_token`.
    traceScopes: Optional. A list of trace scopes.
  """

  nextPageToken = _messages.StringField(1)
  traceScopes = _messages.MessageField('TraceScope', 2, repeated=True)


class ListViewsResponse(_messages.Message):
  r"""Response for listing views.

  Fields:
    nextPageToken: Optional. A token that can be sent as `page_token` to
      retrieve the next page. When this field is omitted, there are no
      subsequent pages.
    views: The list of views.
  """

  nextPageToken = _messages.StringField(1)
  views = _messages.MessageField('View', 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 ObservabilityFoldersLocationsGetRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsGetRequest object.

  Fields:
    name: Resource name for the location.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityFoldersLocationsGetSettingsRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsGetSettingsRequest object.

  Fields:
    name: Required. Name of the settings to retrieve. Name format:
      "projects/[PROJECT_ID]/locations/[LOCATION]/settings"
      "folders/[FOLDER_ID]/locations/[LOCATION]/settings"
      "organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"
  """

  name = _messages.StringField(1, required=True)


class ObservabilityFoldersLocationsListRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsListRequest 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 ObservabilityFoldersLocationsOperationsCancelRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsOperationsCancelRequest 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 ObservabilityFoldersLocationsOperationsDeleteRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsOperationsDeleteRequest object.

  Fields:
    name: The name of the operation resource to be deleted.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityFoldersLocationsOperationsGetRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsOperationsGetRequest object.

  Fields:
    name: The name of the operation resource.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityFoldersLocationsOperationsListRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsOperationsListRequest 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. For example, when `parent` is set to
      `"projects/example/locations/-"`. This field is not supported by default
      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 ObservabilityFoldersLocationsUpdateSettingsRequest(_messages.Message):
  r"""A ObservabilityFoldersLocationsUpdateSettingsRequest object.

  Fields:
    name: Identifier. The resource name of the settings.
    settings: A Settings resource to be passed as the request body.
    updateMask: Optional. The field mask specifying which fields of the
      settings are to be updated.
  """

  name = _messages.StringField(1, required=True)
  settings = _messages.MessageField('Settings', 2)
  updateMask = _messages.StringField(3)


class ObservabilityOrganizationsLocationsGetRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsGetRequest object.

  Fields:
    name: Resource name for the location.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityOrganizationsLocationsGetSettingsRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsGetSettingsRequest object.

  Fields:
    name: Required. Name of the settings to retrieve. Name format:
      "projects/[PROJECT_ID]/locations/[LOCATION]/settings"
      "folders/[FOLDER_ID]/locations/[LOCATION]/settings"
      "organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"
  """

  name = _messages.StringField(1, required=True)


class ObservabilityOrganizationsLocationsListRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsListRequest 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 ObservabilityOrganizationsLocationsOperationsCancelRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsOperationsCancelRequest 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 ObservabilityOrganizationsLocationsOperationsDeleteRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsOperationsDeleteRequest object.

  Fields:
    name: The name of the operation resource to be deleted.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityOrganizationsLocationsOperationsGetRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsOperationsGetRequest object.

  Fields:
    name: The name of the operation resource.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityOrganizationsLocationsOperationsListRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsOperationsListRequest 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. For example, when `parent` is set to
      `"projects/example/locations/-"`. This field is not supported by default
      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 ObservabilityOrganizationsLocationsUpdateSettingsRequest(_messages.Message):
  r"""A ObservabilityOrganizationsLocationsUpdateSettingsRequest object.

  Fields:
    name: Identifier. The resource name of the settings.
    settings: A Settings resource to be passed as the request body.
    updateMask: Optional. The field mask specifying which fields of the
      settings are to be updated.
  """

  name = _messages.StringField(1, required=True)
  settings = _messages.MessageField('Settings', 2)
  updateMask = _messages.StringField(3)


class ObservabilityProjectsLocationsBucketsDatasetsGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsGetRequest object.

  Fields:
    name: Required. Name of the dataset to retrieve. The format is: projects/[
      PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_I
      D]
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsLinksCreateRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsLinksCreateRequest
  object.

  Fields:
    link: A Link resource to be passed as the request body.
    linkId: Required. Id of the link to create.
    parent: Required. Name of the containing dataset for this link. The format
      is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datas
      ets/[DATASET_ID]
  """

  link = _messages.MessageField('Link', 1)
  linkId = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsLinksDeleteRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsLinksDeleteRequest
  object.

  Fields:
    name: Required. Name of the link to delete. The format is: projects/[PROJE
      CT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/li
      nks/[LINK_ID]
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsLinksGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsLinksGetRequest object.

  Fields:
    name: Required. Name of the link to retrieve. The format is: projects/[PRO
      JECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/
      links/[LINK_ID]
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsLinksListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsLinksListRequest object.

  Fields:
    pageSize: Optional. The maximum number of links to return. If unspecified,
      then at most 100 links are returned. The maximum value is 1000; values
      above 1000 are coerced to 1000.
    pageToken: Optional. A page token, received from a previous `ListLinks`
      call. Provide this to retrieve the subsequent page.
    parent: Required. The parent dataset that owns this collection of links.
      The format is: projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKE
      T_ID]/datasets/[DATASET_ID]
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsLinksPatchRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsLinksPatchRequest object.

  Fields:
    link: A Link resource to be passed as the request body.
    name: Identifier. Name of the link. The format is: projects/[PROJECT_ID]/l
      ocations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/links/[LIN
      K_ID]
    updateMask: Optional. The list of fields to update.
  """

  link = _messages.MessageField('Link', 1)
  name = _messages.StringField(2, required=True)
  updateMask = _messages.StringField(3)


class ObservabilityProjectsLocationsBucketsDatasetsListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsListRequest object.

  Fields:
    pageSize: Optional. The maximum number of datasets to return. If
      unspecified, then at most 100 datasets are returned. The maximum value
      is 1000; values above 1000 are coerced to 1000.
    pageToken: Optional. A page token, received from a previous `ListDatasets`
      call. Provide this to retrieve the subsequent page.
    parent: Required. The parent bucket that owns this collection of datasets.
      The format is:
      projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
    showDeleted: Optional. If true, then the response will include deleted
      datasets.
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)
  showDeleted = _messages.BooleanField(4)


class ObservabilityProjectsLocationsBucketsDatasetsViewsGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsViewsGetRequest object.

  Fields:
    name: Required. Name of the view to retrieve. The format is: projects/[PRO
      JECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/
      views/[VIEW_ID]
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsBucketsDatasetsViewsListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsDatasetsViewsListRequest object.

  Fields:
    pageSize: Optional. The maximum number of views to return. If unspecified,
      then at most 100 views are returned. The maximum value is 1000; values
      above 1000 are coerced to 1000.
    pageToken: Optional. A page token, received from a previous `ListViews`
      call. Provide this to retrieve the subsequent page.
    parent: Required. Dataset whose views are to be listed. The format is: pro
      jects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DA
      TASET_ID]
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)


class ObservabilityProjectsLocationsBucketsGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsGetRequest object.

  Fields:
    name: Required. Name of the bucket to retrieve. The format is:
      projects/[PROJECT_ID]/locations/[LOCATION]/buckets/[BUCKET_ID]
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsBucketsListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsBucketsListRequest object.

  Fields:
    pageSize: Optional. The maximum number of buckets to return. If
      unspecified, then at most 100 buckets are returned. The maximum value is
      1000; values above 1000 are coerced to 1000.
    pageToken: Optional. A page token, received from a previous `ListBuckets`
      call. Provide this to retrieve the subsequent page.
    parent: Required. The parent, which owns this collection of buckets. The
      format is: projects/[PROJECT_ID]/locations/[LOCATION]
    showDeleted: Optional. If true, then the response will include deleted
      buckets.
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)
  showDeleted = _messages.BooleanField(4)


class ObservabilityProjectsLocationsGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsGetRequest object.

  Fields:
    name: Resource name for the location.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsGetSettingsRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsGetSettingsRequest object.

  Fields:
    name: Required. Name of the settings to retrieve. Name format:
      "projects/[PROJECT_ID]/locations/[LOCATION]/settings"
      "folders/[FOLDER_ID]/locations/[LOCATION]/settings"
      "organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings"
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsListRequest 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 ObservabilityProjectsLocationsOperationsCancelRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsOperationsCancelRequest 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 ObservabilityProjectsLocationsOperationsDeleteRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsOperationsDeleteRequest object.

  Fields:
    name: The name of the operation resource to be deleted.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsOperationsGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsOperationsGetRequest object.

  Fields:
    name: The name of the operation resource.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsOperationsListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsOperationsListRequest 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. For example, when `parent` is set to
      `"projects/example/locations/-"`. This field is not supported by default
      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 ObservabilityProjectsLocationsScopesGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsScopesGetRequest object.

  Fields:
    name: Required. Name of the resource. The format is:
      projects/{project}/locations/{location}/scopes/{scope} The `{location}`
      field must be set to `global`. The `{scope}` field must be set to
      `_Default`.
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsScopesPatchRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsScopesPatchRequest object.

  Fields:
    name: Identifier. Name of the resource. The format is:
      projects/{project}/locations/{location}/scopes/{scope} The `{location}`
      field must be set to `global`. The `{scope}` field must be set to
      `_Default`.
    scope: A Scope resource to be passed as the request body.
    updateMask: Optional. Field mask is used to specify the fields to be
      overwritten in the Scope resource by the update. The fields specified in
      the update_mask are relative to the resource, not the full request. A
      field is overwritten when it is in the mask. If the user does not
      provide a mask, then all fields present in the request are overwritten.
  """

  name = _messages.StringField(1, required=True)
  scope = _messages.MessageField('Scope', 2)
  updateMask = _messages.StringField(3)


class ObservabilityProjectsLocationsTraceScopesCreateRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsTraceScopesCreateRequest object.

  Fields:
    parent: Required. The full resource name of the location where the trace
      scope should be created projects/[PROJECT_ID]/locations/[LOCATION_ID]
      For example: projects/my-project/locations/global
    traceScope: A TraceScope resource to be passed as the request body.
    traceScopeId: Required. A client-assigned identifier for the trace scope.
  """

  parent = _messages.StringField(1, required=True)
  traceScope = _messages.MessageField('TraceScope', 2)
  traceScopeId = _messages.StringField(3)


class ObservabilityProjectsLocationsTraceScopesDeleteRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsTraceScopesDeleteRequest object.

  Fields:
    name: Required. The full resource name of the trace scope to delete:
      projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_I
      D] For example: projects/my-project/locations/global/traceScopes/my-
      trace-scope
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsTraceScopesGetRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsTraceScopesGetRequest object.

  Fields:
    name: Required. The resource name of the trace scope:
      projects/[PROJECT_ID]/locations/[LOCATION_ID]/traceScopes/[TRACE_SCOPE_I
      D] For example: projects/my-project/locations/global/traceScopes/my-
      trace-scope
  """

  name = _messages.StringField(1, required=True)


class ObservabilityProjectsLocationsTraceScopesListRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsTraceScopesListRequest object.

  Fields:
    pageSize: Optional. The maximum number of results to return from this
      request. Non-positive values are ignored. 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.
    parent: Required. The full resource name of the location to look for trace
      scopes: projects/[PROJECT_ID]/locations/[LOCATION_ID] For example:
      projects/my-project/locations/global
  """

  pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32)
  pageToken = _messages.StringField(2)
  parent = _messages.StringField(3, required=True)


class ObservabilityProjectsLocationsTraceScopesPatchRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsTraceScopesPatchRequest object.

  Fields:
    name: Identifier. The resource name of the trace scope. For example:
      projects/my-project/locations/global/traceScopes/my-trace-scope
    traceScope: A TraceScope resource to be passed as the request body.
    updateMask: Optional. The list of fields to update.
  """

  name = _messages.StringField(1, required=True)
  traceScope = _messages.MessageField('TraceScope', 2)
  updateMask = _messages.StringField(3)


class ObservabilityProjectsLocationsUpdateSettingsRequest(_messages.Message):
  r"""A ObservabilityProjectsLocationsUpdateSettingsRequest object.

  Fields:
    name: Identifier. The resource name of the settings.
    settings: A Settings resource to be passed as the request body.
    updateMask: Optional. The field mask specifying which fields of the
      settings are to be updated.
  """

  name = _messages.StringField(1, required=True)
  settings = _messages.MessageField('Settings', 2)
  updateMask = _messages.StringField(3)


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 OperationMetadata(_messages.Message):
  r"""Represents the metadata of the long-running operation.

  Fields:
    apiVersion: Output only. API version used to start the operation.
    createTime: Output only. The time the operation was created.
    endTime: Output only. The time the operation finished running.
    requestedCancellation: Output only. Identifies whether the user has
      requested cancellation of the operation. Operations that have been
      cancelled successfully have Operation.error value with a
      google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
    statusMessage: Output only. Human-readable status of the operation, if
      any.
    target: Output only. Server-defined resource path for the target of the
      operation.
    verb: Output only. Name of the verb executed by the operation.
  """

  apiVersion = _messages.StringField(1)
  createTime = _messages.StringField(2)
  endTime = _messages.StringField(3)
  requestedCancellation = _messages.BooleanField(4)
  statusMessage = _messages.StringField(5)
  target = _messages.StringField(6)
  verb = _messages.StringField(7)


class Scope(_messages.Message):
  r"""Message describing Scope object

  Fields:
    logScope: Required. The full resource name of the `LogScope`. For example:
      //logging.googleapis.com/projects/myproject/locations/global/logScopes/m
      y-log-scope
    name: Identifier. Name of the resource. The format is:
      projects/{project}/locations/{location}/scopes/{scope} The `{location}`
      field must be set to `global`. The `{scope}` field must be set to
      `_Default`.
    traceScope: Required. The resource name of the `TraceScope`. For example:
      projects/myproject/locations/global/traceScopes/my-trace-scope
    updateTime: Output only. Update timestamp. Note: The Update timestamp for
      the default scope is initially unset.
  """

  logScope = _messages.StringField(1)
  name = _messages.StringField(2)
  traceScope = _messages.StringField(3)
  updateTime = _messages.StringField(4)


class Settings(_messages.Message):
  r"""Describes the settings associated with a project, organization, or
  folder.

  Fields:
    defaultStorageLocation: Optional. The location which should be used when
      any regional resources are provisioned by Google Cloud.
    kmsKeyName: Optional. The resource name for the configured Cloud KMS key.
      KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRing
      s/[KEYRING]/cryptoKeys/[KEY]" For example: `"projects/my-
      project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
    name: Identifier. The resource name of the settings.
    serviceAccountId: Output only. The service account for the given resource
      container, such as project or folder. This will be used by Cloud
      Observability to perform actions in the container's project like access
      KMS keys or create Links. Always the same service account per resource
      container regardless of region.
  """

  defaultStorageLocation = _messages.StringField(1)
  kmsKeyName = _messages.StringField(2)
  name = _messages.StringField(3)
  serviceAccountId = _messages.StringField(4)


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:<tokenid>" 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 TraceScope(_messages.Message):
  r"""A trace scope is a collection of resources whose traces are queried
  together.

  Fields:
    createTime: Output only. The creation timestamp of the trace scope.
    description: Optional. Describes this trace scope. The maximum length of
      the description is 8000 characters.
    name: Identifier. The resource name of the trace scope. For example:
      projects/my-project/locations/global/traceScopes/my-trace-scope
    resourceNames: Required. Names of the projects that are included in this
      trace scope. * `projects/[PROJECT_ID]` A trace scope can include a
      maximum of 20 projects.
    updateTime: Output only. The last update timestamp of the trace scope.
  """

  createTime = _messages.StringField(1)
  description = _messages.StringField(2)
  name = _messages.StringField(3)
  resourceNames = _messages.StringField(4, repeated=True)
  updateTime = _messages.StringField(5)


class View(_messages.Message):
  r"""A view corresponds to a read-only representation of a subset of the data
  in a dataset.

  Fields:
    createTime: Output only. Create timestamp.
    description: Optional. Description of the view.
    displayName: Optional. User friendly display name.
    name: Identifier. Name of the view. The format is: projects/[PROJECT_ID]/l
      ocations/[LOCATION]/buckets/[BUCKET_ID]/datasets/[DATASET_ID]/views/[VIE
      W_ID]
    updateTime: Output only. Update timestamp.
  """

  createTime = _messages.StringField(1)
  description = _messages.StringField(2)
  displayName = _messages.StringField(3)
  name = _messages.StringField(4)
  updateTime = _messages.StringField(5)


encoding.AddCustomJsonFieldMapping(
    StandardQueryParameters, 'f__xgafv', '$.xgafv')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1')
encoding.AddCustomJsonEnumMapping(
    StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2')
