Google Cloud Ruby Client

Idiomatic Ruby client for Google Cloud Platform services.

• Homepage
• API documentation

This client supports the following Google Cloud Platform services:

• Cloud Asset
• Cloud AutoML API
• BigQuery
• BigQuery Data Transfer Service
• Cloud Bigtable
• Cloud Billing API
• Container Analysis
• Container Engine
• Data Loss Prevention
• Cloud Dataproc
• Cloud Datastore
• Cloud Debugger
• Dialogflow API
• Cloud DNS
• Cloud Error Reporting
• Cloud Firestore
• Cloud Key Management Service
• Cloud Natural Language API
• Cloud Logging
• Cloud Monitoring
• Cloud OS Login
• Phishing Protection
• Cloud Pub/Sub
• Recaptcha Enterprise
• Recommender
• Cloud Redis
• Cloud Resource Manager
• Cloud Scheduler
• Secret Manager
• Cloud Security Center
• Cloud Spanner
• Cloud Speech-to-Text
• Cloud Storage
• Cloud Talent Solution
• Cloud Tasks
• Cloud Text-To-Speech
• Cloud Trace
• Cloud Translation API
• Transcoder API
• Video Intelligence API
• Cloud Vision API
• Web Risk API

The support for each service is distributed as a separate gem.

Authentication

In general, the google-cloud-ruby library uses Service Account credentials to connect to Google Cloud services. When running on Google Cloud Platform (GCP), including Google Compute Engine (GCE), Google Kubernetes Engine (GKE), Google App Engine (GAE), Google Cloud Functions (GCF) and Cloud Run, the credentials will be discovered automatically. When running on other environments, the Service Account credentials can be specified by providing the path to the JSON keyfile for the account (or the JSON itself) in environment variables. Additionally, Cloud SDK credentials can also be discovered automatically, but this is only recommended during development.

Specific instructions and environment variables for each individual service are linked from the README documents listed below for each service.

Cloud Asset

• gem install google-cloud-asset
• google-cloud-asset README
• google-cloud-asset API documentation
• google-cloud-asset on RubyGems
• Google Cloud Asset API documentation

Cloud AutoML API

• gem install google-cloud-automl
• google-cloud-automl README
• google-cloud-automl API documentation
• google-cloud-automl on RubyGems
• Google Cloud AutoML API documentation

BigQuery

• gem install google-cloud-bigquery
• google-cloud-bigquery README
• google-cloud-bigquery API documentation
• google-cloud-bigquery on RubyGems
• Google BigQuery documentation

BigQuery Data Transfer Service

• gem install google-cloud-bigquery-data_transfer
• google-bigquery-data_transfer README
• google-bigquery-data_transfer API documentation
• google-bigquery-data_transfer on RubyGems
• Google BigQuery Data Transfer Service documentation

Cloud Bigtable

• gem install google-cloud-bigtable
• google-cloud-bigtable README
• google-cloud-bigtable API documentation
• google-cloud-bigtable on RubyGems
• Google Cloud Bigtable documentation

Cloud Billing API

• gem install google-cloud-billing
• google-cloud-billing README
• google-cloud-billing API documentation
• google-cloud-billing on RubyGems
• Google Cloud Billing documentation

Container Analysis

• gem install google-cloud-container_analysis
• google-cloud-container_analysis README
• google-cloud-container_analysis API documentation
• google-cloud-container_analysis on RubyGems
• Container Analysis documentation

Container Engine

• gem install google-cloud-container
• google-cloud-container README
• google-cloud-container API documentation
• google-cloud-container on RubyGems
• Container Engine documentation

Data Loss Prevention

• gem install google-cloud-dlp
• google-cloud-dlp README
• google-cloud-dlp API documentation
• google-cloud-dlp on RubyGems
• Data Loss Prevention documentation

Cloud Dataproc

• gem install google-cloud-dataproc
• google-cloud-dataproc README
• google-cloud-dataproc API documentation
• google-cloud-dataproc on RubyGems
• Google Cloud Dataproc documentation

Cloud Datastore

• gem install google-cloud-datastore
• google-cloud-datastore README
• google-cloud-datastore API documentation
• google-cloud-datastore on RubyGems
• Google Cloud Datastore documentation

Cloud Debugger

• gem install google-cloud-debugger
• google-cloud-debugger README
• google-cloud-debugger instrumentation documentation
• google-cloud-debugger on RubyGems
• Google Cloud Debugger documentation

Dialogflow API

• gem install google-cloud-dialogflow
• google-cloud-dialogflow README
• google-cloud-dialogflow API documentation
• google-cloud-dialogflow on RubyGems
• Dialogflow API documentation

Cloud DNS

• gem install google-cloud-dns
• google-cloud-dns README
• google-cloud-dns API documentation
• google-cloud-dns on RubyGems
• Google Cloud DNS documentation

Cloud Error Reporting

• gem install google-cloud-error_reporting
• google-cloud-error_reporting README
• google-cloud-error_reporting instrumentation documentation
• google-cloud-error_reporting on RubyGems
• Google Cloud Error Reporting documentation

Cloud Firestore

• gem install google-cloud-firestore
• google-cloud-firestore README
• google-cloud-firestore API documentation
• google-cloud-firestore on RubyGems
• Google Cloud Firestore documentation

Cloud Key Management Service

• gem install google-cloud-kms
• google-cloud-kms README
• google-cloud-kms API documentation
• google-cloud-kms on RubyGems
• Google Cloud KMS documentation

Cloud Natural Language API

• gem install google-cloud-language
• google-cloud-language README
• google-cloud-language API documentation
• google-cloud-language on RubyGems
• Google Cloud Natural Language API documentation

Cloud Logging

• gem install google-cloud-logging
• google-cloud-logging README
• google-cloud-logging API documentation
• google-cloud-logging on RubyGems
• Google Cloud Logging documentation

Cloud Monitoring

• gem install google-cloud-monitoring
• google-cloud-monitoring README
• google-cloud-monitoring API documentation
• google-cloud-monitoring on RubyGems
• Google Cloud Monitoring documentation

Cloud OS Login

• gem install google-cloud-os_login
• google-cloud-os_login README
• google-cloud-os_login API documentation
• google-cloud-os_login on RubyGems
• Google Cloud DNS documentation

Phishing Protection

• gem install google-cloud-phishing_protection
• google-cloud-phishing_protection README
• google-cloud-phishing_protection API documentation
• google-cloud-phishing_protection on RubyGems
• Phishing Protection documentation

Cloud Pub/Sub

• gem install google-cloud-pubsub
• google-cloud-pubsub README
• google-cloud-pubsub API documentation
• google-cloud-pubsub on RubyGems
• Google Cloud Pub/Sub documentation

Recaptcha Enterprise

• gem install google-cloud-recaptcha_enterprise
• google-cloud-recaptcha_enterprise README
• google-cloud-recaptcha_enterprise API documentation
• google-cloud-recaptcha_enterprise on RubyGems
• Recaptcha Enterprise documentation

Recommender

• gem install google-cloud-recommender
• google-cloud-recommender README
• google-cloud-automl API documentation
• google-cloud-recommender on RubyGems
• Google Recommender documentation

Cloud Redis

• gem install google-cloud-redis
• google-cloud-redis README
• google-cloud-redis API documentation
• google-cloud-redis on RubyGems
• Google Cloud Memorystore for Redis documentation

Cloud Resource Manager

• gem install google-cloud-resource_manager
• google-cloud-resource_manager README
• google-cloud-resource_manager API documentation
• google-cloud-resource_manager on RubyGems
• Google Cloud Resource Manager documentation

Cloud Scheduler

• gem install google-cloud-scheduler
• google-cloud-scheduler README
• google-cloud-scheduler API documentation
• google-cloud-scheduler on RubyGems
• Google Cloud Scheduler API documentation

Secret Manager

• gem install google-cloud-secret_manager
• google-cloud-secret_manager README
• google-cloud-automl API documentation
• google-cloud-secret_manager on RubyGems
• Google Secret Manager documentation

Cloud Security Center

• gem install google-cloud-security_center
• google-cloud-security_center README
• google-cloud-security_center API documentation
• google-cloud-security_center on RubyGems
• Google Cloud Security Center documentation

Cloud Spanner

• gem install google-cloud-spanner
• google-cloud-spanner README
• google-cloud-spanner API documentation
• google-cloud-spanner on RubyGems
• Google Cloud Spanner documentation

Cloud Speech-to-Text

• gem install google-cloud-speech
• google-cloud-speech README
• google-cloud-speech API documentation
• google-cloud-speech on RubyGems
• Google Cloud Speech-to-Text documentation

Cloud Storage

• gem install google-cloud-storage
• google-cloud-storage README
• google-cloud-storage API documentation
• google-cloud-storage on RubyGems
• Google Cloud Storage documentation

Cloud Talent Solution

• gem install google-cloud-talent
• google-cloud-talent README
• google-cloud-talent API documentation
• google-cloud-talent on RubyGems
• Google Cloud Talent Solution documentation

Cloud Tasks

• gem install google-cloud-tasks
• google-cloud-tasks README
• google-cloud-tasks API documentation
• google-cloud-tasks on RubyGems
• Google Cloud Tasks documentation

Cloud Text-to-Speech

• gem install google-cloud-text_to_speech
• google-cloud-text_to_speech README
• google-cloud-text_to_speech API documentation
• google-cloud-text_to_speech on RubyGems
• Google Cloud Text-to-Speech documentation

Cloud Trace

• gem install google-cloud-trace
• google-cloud-trace README
• google-cloud-trace instrumentation documentation
• google-cloud-trace on RubyGems
• Google Cloud Trace documentation

Transcoder API

• gem install google-cloud-video-transcoder
• google-cloud-video-transcoder README
• google-cloud-video-transcoder on RubyGems
• Google Cloud Transcoder API documentation

Cloud Translation API

• gem install google-cloud-translate
• google-cloud-translate README
• google-cloud-translate API documentation
• google-cloud-translate on RubyGems
• Google Cloud Translation API documentation

Video Intelligence API

• gem install google-cloud-video_intelligence
• google-cloud-video_intelligence README
• google-cloud-video_intelligence API documentation
• google-cloud-video_intelligence on RubyGems
• Google Cloud Video Intelligence API documentation

Cloud Vision API

• gem install google-cloud-vision
• google-cloud-vision README
• google-cloud-vision API documentation
• google-cloud-vision on RubyGems
• Google Cloud Vision API documentation

Web Risk API

• gem install google-cloud-webrisk
• google-cloud-webrisk README
• google-cloud-webrisk API documentation
• google-cloud-webrisk on RubyGems
• Google Web Risk documentation

Supported Ruby Versions

These libraries are currently supported on Ruby 2.4+.

Google provides official support for Ruby versions that are actively supported by Ruby Core—that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.4 and later. Older versions of Ruby may still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.

Library Versioning

The libraries in this repository follow Semantic Versioning.

Note that different libraries may be released at different support quality levels:

GA: Libraries defined at the GA (general availability) quality level, indicated by a version number greater than or equal to 1.0, are stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues), or unless accompanying a semver-major version update (such as version 1.x to 2.x.) Issues and requests against GA libraries are addressed with the highest priority.

Beta: Libraries defined at a Beta quality level, indicated by a version number less than 1.0, are expected to be mostly stable and we're working towards their release candidate. However, these libraries may get backwards-incompatible updates from time to time. We will still address issues and requests with a high priority.

Contributing

Contributions to this library are always welcome and highly encouraged.

See CONTRIBUTING for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

Support

Please report bugs at the project on Github. Don't hesitate to ask questions about the client or APIs on StackOverflow.