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
  • Generative AI
  • Industry solutions
  • Networking
  • Observability and monitoring
  • Security
  • Storage
Cross-product tools
  • Access and resources management
  • Costs and usage management
  • Infrastructure as code
  • Migration
  • SDK, languages, frameworks, and tools
/
Console
  • English
  • Deutsch
  • Español – América Latina
  • Français
  • Português – Brasil
  • 中文 – 简体
  • 日本語
  • 한국어
Sign in
  • Ruby
  • 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
  • activerecord-spanner-adapter
  • gapic
  • gapic-common
  • google-analytics-admin
  • google-analytics-admin-v1alpha
  • google-analytics-data
  • google-analytics-data-v1alpha
  • google-analytics-data-v1beta
  • google-apps-chat
  • google-apps-chat-v1
  • google-apps-events-subscriptions
  • google-apps-events-subscriptions-v1
  • google-apps-events-subscriptions-v1beta
  • google-apps-meet
  • google-apps-meet-v2
  • google-apps-meet-v2beta
  • google-area120-tables
  • google-area120-tables-v1alpha1
  • google-cloud-access_approval
  • google-cloud-access_approval-v1
  • google-cloud-advisory_notifications
  • google-cloud-advisory_notifications-v1
  • google-cloud-ai_platform
  • google-cloud-ai_platform-v1
  • google-cloud-alloy_db
  • google-cloud-alloy_db-v1
  • google-cloud-alloy_db-v1alpha
  • google-cloud-alloy_db-v1beta
  • google-cloud-api_gateway
  • google-cloud-api_gateway-v1
  • google-cloud-api_hub
  • google-cloud-api_hub-v1
  • google-cloud-api_keys
  • google-cloud-api_keys-v2
  • google-cloud-apigee_connect
  • google-cloud-apigee_connect-v1
  • google-cloud-apigee_registry
  • google-cloud-apigee_registry-v1
  • google-cloud-app_engine
  • google-cloud-app_engine-v1
  • google-cloud-app_hub
  • google-cloud-app_hub-v1
  • google-cloud-artifact_registry
  • google-cloud-artifact_registry-v1
  • google-cloud-artifact_registry-v1beta2
  • google-cloud-asset
  • google-cloud-asset-v1
  • google-cloud-assured_workloads
  • google-cloud-assured_workloads-v1
  • google-cloud-assured_workloads-v1beta1
  • google-cloud-automl
  • google-cloud-automl-v1
  • google-cloud-automl-v1beta1
  • google-cloud-backupdr
  • google-cloud-backupdr-v1
  • google-cloud-bare_metal_solution
  • google-cloud-bare_metal_solution-v2
  • google-cloud-batch
  • google-cloud-batch-v1
  • google-cloud-beyond_corp
  • google-cloud-beyond_corp-app_connections-v1
  • google-cloud-beyond_corp-app_connectors-v1
  • google-cloud-beyond_corp-app_gateways-v1
  • google-cloud-beyond_corp-client_connector_services-v1
  • google-cloud-beyond_corp-client_gateways-v1
  • google-cloud-bigquery
  • google-cloud-bigquery-analytics_hub
  • google-cloud-bigquery-analytics_hub-v1
  • google-cloud-bigquery-connection
  • google-cloud-bigquery-connection-v1
  • google-cloud-bigquery-data_exchange
  • google-cloud-bigquery-data_exchange-v1beta1
  • google-cloud-bigquery-data_policies
  • google-cloud-bigquery-data_policies-v1
  • google-cloud-bigquery-data_policies-v1beta1
  • google-cloud-bigquery-data_transfer
  • google-cloud-bigquery-data_transfer-v1
  • google-cloud-bigquery-migration
  • google-cloud-bigquery-migration-v2
  • google-cloud-bigquery-reservation
  • google-cloud-bigquery-reservation-v1
  • google-cloud-bigquery-storage
  • google-cloud-bigquery-storage-v1
  • google-cloud-bigtable
  • google-cloud-bigtable-admin-v2
  • google-cloud-bigtable-v2
  • google-cloud-billing
  • google-cloud-billing-budgets
  • google-cloud-billing-budgets-v1
  • google-cloud-billing-budgets-v1beta1
  • google-cloud-billing-v1
  • google-cloud-binary_authorization
  • google-cloud-binary_authorization-v1
  • google-cloud-binary_authorization-v1beta1
  • google-cloud-build
  • google-cloud-build-v1
  • google-cloud-build-v2
  • google-cloud-capacity_planner
  • google-cloud-capacity_planner-v1beta
  • google-cloud-certificate_manager
  • google-cloud-certificate_manager-v1
  • google-cloud-channel
  • google-cloud-channel-v1
  • google-cloud-chronicle
  • google-cloud-chronicle-v1
  • google-cloud-cloud_controls_partner
  • google-cloud-cloud_controls_partner-v1
  • google-cloud-cloud_controls_partner-v1beta
  • google-cloud-cloud_dms
  • google-cloud-cloud_dms-v1
  • google-cloud-cloud_quotas
  • google-cloud-cloud_quotas-v1
  • google-cloud-cloud_quotas-v1beta
  • google-cloud-cloud_security_compliance
  • google-cloud-cloud_security_compliance-v1
  • google-cloud-commerce-consumer-procurement
  • google-cloud-commerce-consumer-procurement-v1
  • google-cloud-compute
  • google-cloud-compute-v1
  • google-cloud-confidential_computing
  • google-cloud-confidential_computing-v1
  • google-cloud-config-v1
  • google-cloud-config_delivery
  • google-cloud-config_delivery-v1
  • google-cloud-config_service
  • google-cloud-config_service-v1
  • google-cloud-connectors
  • google-cloud-connectors-v1
  • google-cloud-contact_center_insights
  • google-cloud-contact_center_insights-v1
  • google-cloud-container
  • google-cloud-container-v1
  • google-cloud-container-v1beta1
  • google-cloud-container_analysis
  • google-cloud-container_analysis-v1
  • google-cloud-core
  • google-cloud-data_catalog
  • google-cloud-data_catalog-lineage
  • google-cloud-data_catalog-lineage-v1
  • google-cloud-data_catalog-v1
  • google-cloud-data_catalog-v1beta1
  • google-cloud-data_fusion
  • google-cloud-data_fusion-v1
  • google-cloud-data_labeling
  • google-cloud-data_labeling-v1beta1
  • google-cloud-dataflow
  • google-cloud-dataflow-v1beta3
  • google-cloud-dataform
  • google-cloud-dataform-v1
  • google-cloud-dataform-v1beta1
  • google-cloud-dataplex
  • google-cloud-dataplex-v1
  • google-cloud-dataproc
  • google-cloud-dataproc-v1
  • google-cloud-dataproc-v1beta2
  • google-cloud-dataqna
  • google-cloud-dataqna-v1alpha
  • google-cloud-datastore
  • google-cloud-datastore-admin
  • google-cloud-datastore-admin-v1
  • google-cloud-datastore-v1
  • google-cloud-datastream
  • google-cloud-datastream-v1
  • google-cloud-datastream-v1alpha1
  • google-cloud-debugger
  • google-cloud-debugger-v2
  • google-cloud-deploy
  • google-cloud-deploy-v1
  • google-cloud-developer_connect
  • google-cloud-developer_connect-v1
  • google-cloud-device_streaming
  • google-cloud-device_streaming-v1
  • google-cloud-dialogflow
  • google-cloud-dialogflow-cx
  • google-cloud-dialogflow-cx-v3
  • google-cloud-dialogflow-v2
  • google-cloud-discovery_engine
  • google-cloud-discovery_engine-v1
  • google-cloud-discovery_engine-v1beta
  • google-cloud-dlp
  • google-cloud-dlp-v2
  • google-cloud-dns
  • google-cloud-document_ai
  • google-cloud-document_ai-v1
  • google-cloud-document_ai-v1beta3
  • google-cloud-domains
  • google-cloud-domains-v1
  • google-cloud-domains-v1beta1
  • google-cloud-edge_container
  • google-cloud-edge_container-v1
  • google-cloud-edge_network
  • google-cloud-edge_network-v1
  • google-cloud-env
  • google-cloud-error_reporting
  • google-cloud-error_reporting-v1beta1
  • google-cloud-errors
  • google-cloud-essential_contacts
  • google-cloud-essential_contacts-v1
  • google-cloud-eventarc
  • google-cloud-eventarc-publishing
  • google-cloud-eventarc-publishing-v1
  • google-cloud-eventarc-v1
  • google-cloud-filestore
  • google-cloud-filestore-v1
  • google-cloud-financial_services
  • google-cloud-financial_services-v1
  • google-cloud-firestore
  • google-cloud-firestore-admin
  • google-cloud-firestore-admin-v1
  • google-cloud-firestore-v1
  • google-cloud-functions
  • google-cloud-functions-v1
  • google-cloud-functions-v2
  • google-cloud-gaming
  • google-cloud-gaming-v1
  • google-cloud-gdc_hardware_management
  • google-cloud-gdc_hardware_management-v1alpha
  • google-cloud-gemini_data_analytics
  • google-cloud-gemini_data_analytics-v1beta
  • google-cloud-gke_backup
  • google-cloud-gke_backup-v1
  • google-cloud-gke_connect-gateway
  • google-cloud-gke_connect-gateway-v1
  • google-cloud-gke_connect-gateway-v1beta1
  • google-cloud-gke_hub
  • google-cloud-gke_hub-v1
  • google-cloud-gke_hub-v1beta1
  • google-cloud-gke_multi_cloud
  • google-cloud-gke_multi_cloud-v1
  • google-cloud-gke_recommender
  • google-cloud-gke_recommender-v1
  • google-cloud-gsuite_add_ons
  • google-cloud-gsuite_add_ons-v1
  • google-cloud-iap
  • google-cloud-iap-v1
  • google-cloud-ids
  • google-cloud-ids-v1
  • google-cloud-iot
  • google-cloud-iot-v1
  • google-cloud-kms
  • google-cloud-kms-inventory
  • google-cloud-kms-inventory-v1
  • google-cloud-kms-v1
  • google-cloud-language
  • google-cloud-language-v1
  • google-cloud-language-v1beta2
  • google-cloud-language-v2
  • google-cloud-license_manager
  • google-cloud-license_manager-v1
  • google-cloud-life_sciences
  • google-cloud-life_sciences-v2beta
  • google-cloud-location
  • google-cloud-logging
  • google-cloud-logging-v2
  • google-cloud-lustre
  • google-cloud-lustre-v1
  • google-cloud-maintenance-api
  • google-cloud-maintenance-api-v1beta
  • google-cloud-managed_identities
  • google-cloud-managed_identities-v1
  • google-cloud-managed_kafka
  • google-cloud-managed_kafka-schema_registry
  • google-cloud-managed_kafka-schema_registry-v1
  • google-cloud-managed_kafka-v1
  • google-cloud-media_translation
  • google-cloud-media_translation-v1beta1
  • google-cloud-memcache
  • google-cloud-memcache-v1
  • google-cloud-memcache-v1beta2
  • google-cloud-memorystore
  • google-cloud-memorystore-v1
  • google-cloud-memorystore-v1beta
  • google-cloud-metastore
  • google-cloud-metastore-v1
  • google-cloud-metastore-v1beta
  • google-cloud-migration_center
  • google-cloud-migration_center-v1
  • google-cloud-monitoring
  • google-cloud-monitoring-dashboard-v1
  • google-cloud-monitoring-metrics_scope-v1
  • google-cloud-monitoring-v3
  • google-cloud-netapp
  • google-cloud-netapp-v1
  • google-cloud-network_connectivity
  • google-cloud-network_connectivity-v1
  • google-cloud-network_connectivity-v1alpha1
  • google-cloud-network_management
  • google-cloud-network_management-v1
  • google-cloud-network_security
  • google-cloud-network_security-v1beta1
  • google-cloud-network_services
  • google-cloud-network_services-v1
  • google-cloud-notebooks
  • google-cloud-notebooks-v1
  • google-cloud-notebooks-v1beta1
  • google-cloud-notebooks-v2
  • google-cloud-optimization
  • google-cloud-optimization-v1
  • google-cloud-oracle_database
  • google-cloud-oracle_database-v1
  • google-cloud-orchestration-airflow-service
  • google-cloud-orchestration-airflow-service-v1
  • google-cloud-org_policy
  • google-cloud-org_policy-v2
  • google-cloud-os_config
  • google-cloud-os_config-v1
  • google-cloud-os_config-v1alpha
  • google-cloud-os_login
  • google-cloud-os_login-v1
  • google-cloud-os_login-v1beta
  • google-cloud-parallelstore
  • google-cloud-parallelstore-v1
  • google-cloud-parallelstore-v1beta
  • google-cloud-parameter_manager
  • google-cloud-parameter_manager-v1
  • google-cloud-phishing_protection
  • google-cloud-phishing_protection-v1beta1
  • google-cloud-policy_simulator
  • google-cloud-policy_simulator-v1
  • google-cloud-policy_troubleshooter
  • google-cloud-policy_troubleshooter-iam-v3
  • google-cloud-policy_troubleshooter-v1
  • google-cloud-private_catalog
  • google-cloud-private_catalog-v1beta1
  • google-cloud-privileged_access_manager
  • google-cloud-privileged_access_manager-v1
  • google-cloud-profiler
  • google-cloud-profiler-v2
  • google-cloud-pubsub
  • google-cloud-pubsub-v1
  • google-cloud-rapid_migration_assessment
  • google-cloud-rapid_migration_assessment-v1
  • google-cloud-recaptcha_enterprise
  • google-cloud-recaptcha_enterprise-v1
  • google-cloud-recaptcha_enterprise-v1beta1
  • google-cloud-recommendation_engine
  • google-cloud-recommendation_engine-v1beta1
  • google-cloud-recommender
  • google-cloud-recommender-v1
  • google-cloud-redis
  • google-cloud-redis-cluster
  • google-cloud-redis-cluster-v1
  • google-cloud-redis-cluster-v1beta1
  • google-cloud-redis-v1
  • google-cloud-redis-v1beta1
  • google-cloud-resource_manager
  • google-cloud-resource_manager-v3
  • google-cloud-retail
  • google-cloud-retail-v2
  • google-cloud-run-client
  • google-cloud-run-v2
  • google-cloud-saas_platform-saas_service_mgmt
  • google-cloud-saas_platform-saas_service_mgmt-v1beta1
  • google-cloud-scheduler
  • google-cloud-scheduler-v1
  • google-cloud-scheduler-v1beta1
  • google-cloud-secret_manager
  • google-cloud-secret_manager-v1
  • google-cloud-secret_manager-v1beta1
  • google-cloud-secret_manager-v1beta2
  • google-cloud-secure_source_manager
  • google-cloud-secure_source_manager-v1
  • google-cloud-security-private_ca
  • google-cloud-security-private_ca-v1
  • google-cloud-security-private_ca-v1beta1
  • google-cloud-security-public_ca
  • google-cloud-security-public_ca-v1
  • google-cloud-security-public_ca-v1beta1
  • google-cloud-security_center
  • google-cloud-security_center-v1
  • google-cloud-security_center-v1p1beta1
  • google-cloud-security_center-v2
  • google-cloud-security_center_management
  • google-cloud-security_center_management-v1
  • google-cloud-service_control
  • google-cloud-service_control-v1
  • google-cloud-service_directory
  • google-cloud-service_directory-v1
  • google-cloud-service_directory-v1beta1
  • google-cloud-service_health
  • google-cloud-service_health-v1
  • google-cloud-service_management
  • google-cloud-service_management-v1
  • google-cloud-service_usage
  • google-cloud-service_usage-v1
  • google-cloud-shell
  • google-cloud-shell-v1
  • google-cloud-spanner
  • google-cloud-spanner-admin-database-v1
  • google-cloud-spanner-admin-instance-v1
  • google-cloud-spanner-v1
  • google-cloud-speech
  • google-cloud-speech-v1
  • google-cloud-speech-v1p1beta1
  • google-cloud-speech-v2
  • google-cloud-storage
  • google-cloud-storage-control
  • google-cloud-storage-control-v2
  • google-cloud-storage_batch_operations
  • google-cloud-storage_batch_operations-v1
  • google-cloud-storage_insights
  • google-cloud-storage_insights-v1
  • google-cloud-storage_transfer
  • google-cloud-storage_transfer-v1
  • google-cloud-support
  • google-cloud-support-v2
  • google-cloud-support-v2beta
  • google-cloud-talent
  • google-cloud-talent-v4
  • google-cloud-talent-v4beta1
  • google-cloud-tasks
  • google-cloud-tasks-v2
  • google-cloud-tasks-v2beta2
  • google-cloud-tasks-v2beta3
  • google-cloud-telco_automation
  • google-cloud-telco_automation-v1
  • google-cloud-text_to_speech
  • google-cloud-text_to_speech-v1
  • google-cloud-text_to_speech-v1beta1
  • google-cloud-tpu
  • google-cloud-tpu-v1
  • google-cloud-trace
  • google-cloud-trace-v1
  • google-cloud-trace-v2
    • Overview
      • Getting started
      • Authenticating the library
    • Google
    • Google::Api
    • Google::Api::ClientLibraryDestination
    • Google::Api::ClientLibraryOrganization
    • Google::Api::ClientLibrarySettings
    • Google::Api::CommonLanguageSettings
    • Google::Api::CppSettings
    • Google::Api::DotnetSettings
    • Google::Api::DotnetSettings::RenamedResourcesEntry
    • Google::Api::DotnetSettings::RenamedServicesEntry
    • Google::Api::FieldBehavior
    • Google::Api::GoSettings
    • Google::Api::GoSettings::RenamedServicesEntry
    • Google::Api::JavaSettings
    • Google::Api::JavaSettings::ServiceClassNamesEntry
    • Google::Api::LaunchStage
    • Google::Api::MethodSettings
    • Google::Api::MethodSettings::LongRunning
    • Google::Api::NodeSettings
    • Google::Api::PhpSettings
    • Google::Api::Publishing
    • Google::Api::PythonSettings
    • Google::Api::PythonSettings::ExperimentalFeatures
    • Google::Api::ResourceDescriptor
    • Google::Api::ResourceDescriptor::History
    • Google::Api::ResourceDescriptor::Style
    • Google::Api::ResourceReference
    • Google::Api::RubySettings
    • Google::Api::SelectiveGapicGeneration
    • Google::Cloud
    • Google::Cloud::Trace
    • Google::Cloud::Trace::V2
    • Google::Cloud::Trace::V2::AttributeValue
    • Google::Cloud::Trace::V2::BatchWriteSpansRequest
    • Google::Cloud::Trace::V2::Module
    • Google::Cloud::Trace::V2::Span
    • Google::Cloud::Trace::V2::Span::Attributes
    • Google::Cloud::Trace::V2::Span::Attributes::AttributeMapEntry
    • Google::Cloud::Trace::V2::Span::Link
    • Google::Cloud::Trace::V2::Span::Link::Type
    • Google::Cloud::Trace::V2::Span::Links
    • Google::Cloud::Trace::V2::Span::SpanKind
    • Google::Cloud::Trace::V2::Span::TimeEvent
    • Google::Cloud::Trace::V2::Span::TimeEvent::Annotation
    • Google::Cloud::Trace::V2::Span::TimeEvent::MessageEvent
    • Google::Cloud::Trace::V2::Span::TimeEvent::MessageEvent::Type
    • Google::Cloud::Trace::V2::Span::TimeEvents
    • Google::Cloud::Trace::V2::StackTrace
    • Google::Cloud::Trace::V2::StackTrace::StackFrame
    • Google::Cloud::Trace::V2::StackTrace::StackFrames
    • Google::Cloud::Trace::V2::TraceService
    • Google::Cloud::Trace::V2::TraceService::Client
    • Google::Cloud::Trace::V2::TraceService::Client::Configuration
    • Google::Cloud::Trace::V2::TraceService::Client::Configuration::Rpcs
    • Google::Cloud::Trace::V2::TraceService::Credentials
    • Google::Cloud::Trace::V2::TraceService::Paths
    • Google::Cloud::Trace::V2::TraceService::Rest
    • Google::Cloud::Trace::V2::TraceService::Rest::Client
    • Google::Cloud::Trace::V2::TraceService::Rest::Client::Configuration
    • Google::Cloud::Trace::V2::TraceService::Rest::Client::Configuration::Rpcs
    • Google::Cloud::Trace::V2::TraceService::Rest::ServiceStub
    • Google::Cloud::Trace::V2::TruncatableString
    • Google::Protobuf
    • Google::Protobuf::Any
    • Google::Protobuf::BoolValue
    • Google::Protobuf::BytesValue
    • Google::Protobuf::DoubleValue
    • Google::Protobuf::Duration
    • Google::Protobuf::Empty
    • Google::Protobuf::FloatValue
    • Google::Protobuf::Int32Value
    • Google::Protobuf::Int64Value
    • Google::Protobuf::StringValue
    • Google::Protobuf::Timestamp
    • Google::Protobuf::UInt32Value
    • Google::Protobuf::UInt64Value
    • Google::Rpc
    • Google::Rpc::Status
  • google-cloud-translate
  • google-cloud-translate-v2
  • google-cloud-translate-v3
  • google-cloud-video-live_stream
  • google-cloud-video-live_stream-v1
  • google-cloud-video-stitcher
  • google-cloud-video-stitcher-v1
  • google-cloud-video-transcoder
  • google-cloud-video-transcoder-v1
  • google-cloud-video_intelligence
  • google-cloud-video_intelligence-v1
  • google-cloud-video_intelligence-v1beta2
  • google-cloud-video_intelligence-v1p1beta1
  • google-cloud-video_intelligence-v1p2beta1
  • google-cloud-video_intelligence-v1p3beta1
  • google-cloud-vision
  • google-cloud-vision-v1
  • google-cloud-vision-v1p3beta1
  • google-cloud-vision-v1p4beta1
  • google-cloud-vision_ai
  • google-cloud-vision_ai-v1
  • google-cloud-vm_migration
  • google-cloud-vm_migration-v1
  • google-cloud-vmware_engine
  • google-cloud-vmware_engine-v1
  • google-cloud-vpc_access
  • google-cloud-vpc_access-v1
  • google-cloud-web_risk
  • google-cloud-web_risk-v1
  • google-cloud-web_risk-v1beta1
  • google-cloud-web_security_scanner
  • google-cloud-web_security_scanner-v1
  • google-cloud-web_security_scanner-v1beta
  • google-cloud-webrisk
  • google-cloud-workflows
  • google-cloud-workflows-executions-v1
  • google-cloud-workflows-executions-v1beta
  • google-cloud-workflows-v1
  • google-cloud-workflows-v1beta
  • google-cloud-workstations
  • google-cloud-workstations-v1
  • google-cloud-workstations-v1beta
  • google-iam-credentials
  • google-iam-credentials-v1
  • google-iam-v1
  • google-iam-v1beta
  • google-iam-v3
  • google-iam-v3beta
  • google-identity-access_context_manager
  • google-identity-access_context_manager-v1
  • google-logging-utils
  • googleauth
  • grafeas
  • grafeas-v1
  • opentelemetry-exporter-google_cloud_trace
  • signet
  • stackdriver
  • stackdriver-core
  • AI and ML
  • Application development
  • Application hosting
  • Compute
  • Data analytics and pipelines
  • Databases
  • Distributed, hybrid, and multicloud
  • Generative AI
  • Industry solutions
  • Networking
  • Observability and monitoring
  • Security
  • Storage
  • Access and resources management
  • Costs and usage management
  • Infrastructure as code
  • Migration
  • SDK, languages, frameworks, and tools
  • Home
  • Technology areas
  • Ruby
  • Client libraries
Stay organized with collections Save and categorize content based on your preferences.
  • 1.4.1 (latest)
  • 1.4.0
  • 1.3.0
  • 1.2.1
  • 1.1.0
  • 1.0.1
  • 0.9.0
  • 0.8.2
  • 0.7.0
  • 0.6.1
  • 0.5.0
  • 0.4.1