Skip to main content
Google Cloud Documentation
Technology areas
  • AI and ML
  • Application development
  • Application hosting
  • Compute
  • Data analytics and pipelines
  • Databases
  • Distributed, hybrid, and multicloud
  • Industry solutions
  • Migration
  • Networking
  • Observability and monitoring
  • Security
  • Storage
Cross-product tools
  • Access and resources management
  • Costs and usage management
  • Infrastructure as code
  • SDK, languages, frameworks, and tools
/
Console
  • English
  • Deutsch
  • Español – América Latina
  • Français
  • Português – Brasil
  • 中文 – 简体
  • 日本語
  • 한국어
Sign in
  • Python
  • Client libraries
Start free
Overview Guides Reference Samples
Google Cloud Documentation
  • Technology areas
    • More
    • Overview
    • Guides
    • Reference
    • Samples
  • Cross-product tools
    • More
  • Console
  • Overview
  • Library reference docs
  • BigQuery DataFrames
  • google-cloud-access-approval
  • google-cloud-advisorynotifications
  • google-cloud-agentplatform
  • google-cloud-aiplatform
  • google-cloud-alloydb
  • google-cloud-alloydb-connectors
  • google-cloud-api-gateway
  • google-cloud-api-keys
  • google-cloud-apigee-connect
  • google-cloud-apigee-registry
  • google-cloud-apihub
  • google-cloud-apiregistry
  • google-cloud-appengine-admin
  • google-cloud-appengine-logging
  • google-cloud-apphub
  • google-cloud-artifact-registry
  • google-cloud-asset
  • google-cloud-assured-workloads
  • google-cloud-audit-log
  • google-cloud-auditmanager
  • google-cloud-automl
  • google-cloud-backupdr
  • google-cloud-bare-metal-solution
  • google-cloud-batch
  • google-cloud-beyondcorp-appconnections
  • google-cloud-beyondcorp-appconnectors
  • google-cloud-beyondcorp-appgateways
  • google-cloud-beyondcorp-clientconnectorservices
  • google-cloud-beyondcorp-clientgateways
  • google-cloud-biglake
  • google-cloud-biglake-hive
  • google-cloud-bigquery
  • google-cloud-bigquery-biglake
  • google-cloud-bigquery-connection
  • google-cloud-bigquery-data-exchange
  • google-cloud-bigquery-datapolicies
  • google-cloud-bigquery-datatransfer
  • google-cloud-bigquery-logging
  • google-cloud-bigquery-migration
  • google-cloud-bigquery-reservation
  • google-cloud-bigquery-storage
  • google-cloud-bigtable
  • google-cloud-billing
  • google-cloud-billing-budgets
  • google-cloud-binary-authorization
  • google-cloud-build
  • google-cloud-capacityplanner
  • google-cloud-certificate-manager
  • google-cloud-ces
  • google-cloud-channel
  • google-cloud-chronicle
    • Overview
    • google-cloud-chronicle APIs
      • API overview
      • Classes
      • Methods
      • Properties and Attributes
    • Changelog
    • Multiprocessing
    • Chronicle V1
      • big_query_export_service
        • Overview
        • BigQueryExportServiceAsyncClient
        • BigQueryExportServiceClient
      • dashboard_chart_service
        • Overview
        • DashboardChartServiceAsyncClient
        • DashboardChartServiceClient
      • dashboard_query_service
        • Overview
        • DashboardQueryServiceAsyncClient
        • DashboardQueryServiceClient
      • data_access_control_service
        • Overview
        • pagers
          • Overview
          • ListDataAccessLabelsAsyncPager
          • ListDataAccessLabelsPager
          • ListDataAccessScopesAsyncPager
          • ListDataAccessScopesPager
        • DataAccessControlServiceAsyncClient
        • DataAccessControlServiceClient
      • data_table_service
        • Overview
        • pagers
          • Overview
          • ListDataTableRowsAsyncPager
          • ListDataTableRowsPager
          • ListDataTablesAsyncPager
          • ListDataTablesPager
        • DataTableServiceAsyncClient
        • DataTableServiceClient
      • entity_service
        • Overview
        • pagers
          • Overview
          • ListWatchlistsAsyncPager
          • ListWatchlistsPager
        • EntityServiceAsyncClient
        • EntityServiceClient
      • featured_content_native_dashboard_service
        • Overview
        • pagers
          • Overview
          • ListFeaturedContentNativeDashboardsAsyncPager
          • ListFeaturedContentNativeDashboardsPager
        • FeaturedContentNativeDashboardServiceAsyncClient
        • FeaturedContentNativeDashboardServiceClient
      • instance_service
        • Overview
        • InstanceServiceAsyncClient
        • InstanceServiceClient
      • native_dashboard_service
        • Overview
        • pagers
          • Overview
          • ListNativeDashboardsAsyncPager
          • ListNativeDashboardsPager
        • NativeDashboardServiceAsyncClient
        • NativeDashboardServiceClient
      • reference_list_service
        • Overview
        • pagers
          • Overview
          • ListReferenceListsAsyncPager
          • ListReferenceListsPager
        • ReferenceListServiceAsyncClient
        • ReferenceListServiceClient
      • rule_service
        • Overview
        • pagers
          • Overview
          • ListRetrohuntsAsyncPager
          • ListRetrohuntsPager
          • ListRuleDeploymentsAsyncPager
          • ListRuleDeploymentsPager
          • ListRuleRevisionsAsyncPager
          • ListRuleRevisionsPager
          • ListRulesAsyncPager
          • ListRulesPager
        • RuleServiceAsyncClient
        • RuleServiceClient
      • types
        • Overview
        • AddChartRequest
        • AddChartResponse
        • AdvancedFilterConfig
          • Overview
          • ManualOptions
          • QueryOptions
          • ValueSource
        • AxisType
        • BatchGetDashboardChartsRequest
        • BatchGetDashboardChartsResponse
        • BigQueryExport
        • BigQueryExportPackage
        • BulkCreateDataTableRowsRequest
        • BulkCreateDataTableRowsResponse
        • BulkGetDataTableRowsRequest
        • BulkGetDataTableRowsResponse
        • BulkReplaceDataTableRowsRequest
        • BulkReplaceDataTableRowsResponse
        • BulkUpdateDataTableRowsRequest
        • BulkUpdateDataTableRowsResponse
        • Button
          • Overview
          • Properties
        • ButtonStyle
        • ColumnMetadata
        • CompilationDiagnostic
          • Overview
          • Severity
        • CompilationPosition
        • CreateDataAccessLabelRequest
        • CreateDataAccessScopeRequest
        • CreateDataTableRequest
        • CreateDataTableRowRequest
        • CreateNativeDashboardRequest
        • CreateReferenceListRequest
        • CreateRetrohuntRequest
        • CreateRuleRequest
        • CreateWatchlistRequest
        • DashboardAccess
        • DashboardChart
          • Overview
          • ChartDatasource
          • DrillDownConfig
            • Overview
            • DrillDown
              • Overview
              • CustomDrillDownSettings
                • Overview
                • DrillDownExternalLink
                • DrillDownFilter
                  • Overview
                  • DrillDownDashboardFilter
                • DrillDownQuery
              • DefaultDrillDownSettings
          • Visualization
            • Overview
            • Axis
            • ColumnDef
            • ColumnRenderTypeSettings
            • ColumnTooltipSettings
            • GoogleMapsConfig
              • Overview
              • DataSettings
              • MapPosition
              • PointSettings
            • Legend
            • Series
              • Overview
              • AreaStyle
              • ChartSliceColor
              • DataLabel
              • Encode
              • GaugeConfig
              • GaugeValue
              • ItemColors
              • ItemStyle
              • MetricTrendConfig
              • UserSelectedValues
            • TableConfig
            • Tooltip
            • VisualMap
              • Overview
              • VisualMapPiece
        • DashboardDefinition
          • Overview
          • ChartConfig
            • Overview
            • ChartLayout
        • DashboardFilter
        • DashboardQuery
          • Overview
          • Input
            • Overview
            • RelativeTime
        • DashboardType
        • DashboardUserData
        • DataAccessLabel
        • DataAccessLabelReference
        • DataAccessScope
        • DataSource
        • DataSourceExportSettings
        • DataTable
        • DataTableColumnInfo
          • Overview
          • DataTableColumnType
        • DataTableOperationErrors
        • DataTableRow
        • DataTableScopeInfo
        • DataTableUpdateSource
        • DeleteDataAccessLabelRequest
        • DeleteDataAccessScopeRequest
        • DeleteDataTableRequest
        • DeleteDataTableRowRequest
        • DeleteNativeDashboardRequest
        • DeleteRuleRequest
        • DeleteWatchlistRequest
        • DuplicateChartRequest
        • DuplicateChartResponse
        • DuplicateNativeDashboardRequest
        • EditChartRequest
        • EditChartResponse
        • ExecuteDashboardQueryRequest
        • ExecuteDashboardQueryResponse
          • Overview
          • ColumnData
          • ColumnType
            • Overview
            • List
          • ColumnValue
            • Overview
            • ValueMetadata
        • ExportNativeDashboardsRequest
        • ExportNativeDashboardsResponse
        • FeaturedContentMetadata
          • Overview
          • ContentSourceType
        • FeaturedContentNativeDashboard
        • FilterOperator
        • FilterOperatorAndValues
        • GetBigQueryExportRequest
        • GetDashboardChartRequest
        • GetDashboardQueryRequest
        • GetDataAccessLabelRequest
        • GetDataAccessScopeRequest
        • GetDataTableOperationErrorsRequest
        • GetDataTableRequest
        • GetDataTableRowRequest
        • GetFeaturedContentNativeDashboardRequest
        • GetInstanceRequest
        • GetNativeDashboardRequest
        • GetReferenceListRequest
        • GetRetrohuntRequest
        • GetRuleDeploymentRequest
        • GetRuleRequest
        • GetWatchlistRequest
        • ImportExportStatus
        • ImportNativeDashboardsInlineSource
        • ImportNativeDashboardsRequest
        • ImportNativeDashboardsResponse
        • InAppLink
        • IngestionLabel
        • InlineDestination
        • InputsUsed
        • InstallFeaturedContentNativeDashboardRequest
        • InstallFeaturedContentNativeDashboardResponse
        • Instance
        • LanguageFeature
        • LatestExportJobState
        • LegendAlign
        • LegendOrient
        • ListDataAccessLabelsRequest
        • ListDataAccessLabelsResponse
        • ListDataAccessScopesRequest
        • ListDataAccessScopesResponse
        • ListDataTableRowsRequest
        • ListDataTableRowsResponse
        • ListDataTablesRequest
        • ListDataTablesResponse
        • ListFeaturedContentNativeDashboardsRequest
        • ListFeaturedContentNativeDashboardsResponse
        • ListNativeDashboardsRequest
        • ListNativeDashboardsResponse
        • ListReferenceListsRequest
        • ListReferenceListsResponse
        • ListRetrohuntsRequest
        • ListRetrohuntsResponse
        • ListRuleDeploymentsRequest
        • ListRuleDeploymentsResponse
        • ListRuleRevisionsRequest
        • ListRuleRevisionsResponse
        • ListRulesRequest
        • ListRulesResponse
        • ListWatchlistsRequest
        • ListWatchlistsResponse
        • Markdown
          • Overview
          • MarkdownProperties
        • MetricDisplayTrend
        • MetricFormat
        • MetricTrendType
        • NativeDashboard
        • NativeDashboardView
        • NativeDashboardWithChartsAndQueries
        • PlotMode
        • PointSizeType
        • ProvisionBigQueryExportRequest
        • QueryRuntimeError
          • Overview
          • ErrorSeverity
          • MetadataKey
          • QueryRuntimeErrorMetadata
          • WarningReason
        • ReferenceList
        • ReferenceListEntry
        • ReferenceListScope
        • ReferenceListSyntaxType
        • ReferenceListView
        • RemoveChartRequest
        • RenderType
        • Retrohunt
          • Overview
          • State
        • RetrohuntMetadata
        • Rule
          • Overview
          • CompilationState
          • MetadataEntry
        • RuleDeployment
          • Overview
          • ExecutionState
        • RuleType
        • RuleView
        • RunFrequency
        • ScopeInfo
        • SeriesStackStrategy
        • SeriesType
        • Severity
        • TileType
        • TimeUnit
        • TimestampMetadata
        • ToolTipTrigger
        • UpdateBigQueryExportRequest
        • UpdateDataAccessLabelRequest
        • UpdateDataAccessScopeRequest
        • UpdateDataTableRequest
        • UpdateDataTableRowRequest
        • UpdateNativeDashboardRequest
        • UpdateReferenceListRequest
        • UpdateRuleDeploymentRequest
        • UpdateRuleRequest
        • UpdateWatchlistRequest
        • VisualMapType
        • Watchlist
          • Overview
          • EntityCount
          • EntityPopulationMechanism
            • Overview
            • Manual
        • WatchlistUserPreferences
  • google-cloud-cloudcontrolspartner
  • google-cloud-cloudsecuritycompliance
  • google-cloud-commerce-consumer-procurement
  • google-cloud-common
  • google-cloud-compute
  • google-cloud-compute-v1beta
  • google-cloud-confidentialcomputing
  • google-cloud-config
  • google-cloud-configdelivery
  • google-cloud-contact-center-insights
  • google-cloud-container
  • google-cloud-containeranalysis
  • google-cloud-contentwarehouse
  • google-cloud-core
  • google-cloud-data-fusion
  • google-cloud-data-qna
  • google-cloud-databasecenter
  • google-cloud-datacatalog
  • google-cloud-datacatalog-lineage
  • google-cloud-datacatalog-lineage-configmanagement
  • google-cloud-dataflow-client
  • google-cloud-dataform
  • google-cloud-datalabeling
  • google-cloud-dataplex
  • google-cloud-dataproc
  • google-cloud-dataproc-metastore
  • google-cloud-datastore
  • google-cloud-datastream
  • google-cloud-debugger-client
  • google-cloud-deploy
  • google-cloud-developerconnect
  • google-cloud-devicestreaming
  • google-cloud-dialogflow
  • google-cloud-dialogflow-cx
  • google-cloud-discoveryengine
  • google-cloud-dlp
  • google-cloud-dms
  • google-cloud-dns
  • google-cloud-documentai
  • google-cloud-documentai-toolbox
  • google-cloud-domains
  • google-cloud-edgecontainer
  • google-cloud-edgenetwork
  • google-cloud-enterpriseknowledgegraph
  • google-cloud-error-reporting
  • google-cloud-essential-contacts
  • google-cloud-eventarc
  • google-cloud-eventarc-publishing
  • google-cloud-filestore
  • google-cloud-financialservices
  • google-cloud-firestore
  • google-cloud-functions
  • google-cloud-game-servers
  • google-cloud-gdchardwaremanagement
  • google-cloud-geminidataanalytics
  • google-cloud-gke-backup
  • google-cloud-gke-connect-gateway
  • google-cloud-gke-hub
  • google-cloud-gke-multicloud
  • google-cloud-gkerecommender
  • google-cloud-gsuiteaddons
  • google-cloud-hypercomputecluster
  • google-cloud-iam
  • google-cloud-iam-logging
  • google-cloud-iap
  • google-cloud-ids
  • google-cloud-iot
  • google-cloud-kms
  • google-cloud-kms-inventory
  • google-cloud-language
  • google-cloud-licensemanager
  • google-cloud-life-sciences
  • google-cloud-locationfinder
  • google-cloud-logging
  • google-cloud-lustre
  • google-cloud-maintenance-api
  • google-cloud-managed-identities
  • google-cloud-managedkafka
  • google-cloud-managedkafka-schemaregistry
  • google-cloud-media-translation
  • google-cloud-memcache
  • google-cloud-memorystore
  • google-cloud-migrationcenter
  • google-cloud-modelarmor
  • google-cloud-monitoring
  • google-cloud-monitoring-dashboards
  • google-cloud-monitoring-metrics-scopes
  • google-cloud-netapp
  • google-cloud-network-connectivity
  • google-cloud-network-management
  • google-cloud-network-security
  • google-cloud-network-services
  • google-cloud-notebooks
  • google-cloud-optimization
  • google-cloud-oracledatabase
  • google-cloud-orchestration-airflow
  • google-cloud-org-policy
  • google-cloud-os-config
  • google-cloud-os-login
  • google-cloud-parallelstore
  • google-cloud-parametermanager
  • google-cloud-phishing-protection
  • google-cloud-policy-troubleshooter
  • google-cloud-policysimulator
  • google-cloud-policytroubleshooter-iam
  • google-cloud-private-ca
  • google-cloud-private-catalog
  • google-cloud-privilegedaccessmanager
  • google-cloud-pubsub
  • google-cloud-pubsublite
  • google-cloud-quotas
  • google-cloud-rapidmigrationassessment
  • google-cloud-recaptcha-enterprise
  • google-cloud-recommendations-ai
  • google-cloud-recommender
  • google-cloud-redis
  • google-cloud-redis-cluster
  • google-cloud-resource-manager
  • google-cloud-retail
  • google-cloud-run
  • google-cloud-runtimeconfig
  • google-cloud-saasplatform-saasservicemgmt
  • google-cloud-scheduler
  • google-cloud-secret-manager
  • google-cloud-securesourcemanager
  • google-cloud-security-publicca
  • google-cloud-securitycenter
  • google-cloud-securitycentermanagement
  • google-cloud-service-control
  • google-cloud-service-directory
  • google-cloud-service-management
  • google-cloud-service-usage
  • google-cloud-servicehealth
  • google-cloud-shell
  • google-cloud-source-context
  • google-cloud-spanner
  • google-cloud-speech
  • google-cloud-storage
  • google-cloud-storage-control
  • google-cloud-storage-transfer
  • google-cloud-storagebatchoperations
  • google-cloud-storageinsights
  • google-cloud-support
  • google-cloud-talent
  • google-cloud-tasks
  • google-cloud-telcoautomation
  • google-cloud-texttospeech
  • google-cloud-tpu
  • google-cloud-trace
  • google-cloud-translate
  • google-cloud-vectorsearch
  • google-cloud-vertexai
  • google-cloud-video-live-stream
  • google-cloud-video-stitcher
  • google-cloud-video-transcoder
  • google-cloud-videointelligence
  • google-cloud-vision
  • google-cloud-visionai
  • google-cloud-vm-migration
  • google-cloud-vmwareengine
  • google-cloud-vpc-access
  • google-cloud-webrisk
  • google-cloud-websecurityscanner
  • google-cloud-workflows
  • google-cloud-workloadmanager
  • google-cloud-workstations
  • google-resumable-media
  • googleapis-common-protos
  • grpc-google-iam-v1
  • langchain-google-alloydb-pg
  • langchain-google-bigtable
  • langchain-google-cloud-sql-mssql
  • langchain-google-cloud-sql-mysql
  • langchain-google-cloud-sql-pg
  • langchain-google-datastore
  • langchain-google-el-carro
  • langchain-google-firestore
  • langchain-google-memorystore-redis
  • langchain-google-spanner
  • llama-index-alloydb-pg
  • llama-index-cloud-sql-pg
  • llama-index-spanner
  • AI and ML
  • Application development
  • Application hosting
  • Compute
  • Data analytics and pipelines
  • Databases
  • Distributed, hybrid, and multicloud
  • Industry solutions
  • Migration
  • Networking
  • Observability and monitoring
  • Security
  • Storage
  • Access and resources management
  • Costs and usage management
  • Infrastructure as code
  • SDK, languages, frameworks, and tools
  • Home
  • Documentation
  • Developer tools
  • Python
  • Client libraries

Class Properties (0.6.0) Stay organized with collections Save and categorize content based on your preferences.

Properties(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-06-02 UTC.

  • Products and pricing

    • See all products
    • Google Cloud pricing
    • Google Cloud Marketplace
    • Contact sales
  • Support

    • Community forums
    • Support
    • Release Notes
    • System status
  • Resources

    • GitHub
    • Getting Started with Google Cloud
    • Code samples
    • Cloud Architecture Center
    • Training and Certification
  • Engage

    • Blog
    • Events
    • X (Twitter)
    • Google Cloud on YouTube
    • Google Cloud Tech on YouTube
  • About Google
  • Privacy
  • Site terms
  • Google Cloud terms
  • Manage cookies
  • Our third decade of climate action: join us
  • Sign up for the Google Cloud newsletter Subscribe
  • English
  • Deutsch
  • Español – América Latina
  • Français
  • Português – Brasil
  • 中文 – 简体
  • 日本語
  • 한국어