Repository files navigation

Java idiomatic client forGoogle Cloud Platform services.

• Java on Google Cloud

See theofficial guide to get setup and started with development.

Libraries are available on GitHub and Maven Central for developing Java applications that interact with individual Google Cloud services:

Client	Release Level	Version
AI Platform Notebooks
API Gateway
API Keys API
Access Approval
Advisory Notifications API
AlloyDB
AlloyDB connectors
Analytics Hub API
Apigee Connect
App Engine Admin API
Artifact Registry
Asset Inventory
Assured Workloads for Government
Auto ML
Backup and DR Service API
BigQuery
BigQuery Connection
BigQuery Data Transfer Service
BigQuery Reservation
BigQuery Storage
Bigtable
Bigtable Hbase Client
Billing
Billing Budgets
Binary Authorization
Build
CCAI Insights
Certificate Authority Service
Channel Services
Composer
Compute Engine
Connect Gateway API
Container Analysis
Controls Partner API
DNS
Data Catalog
Data Fusion
Data Lineage
Data Loss Prevention
Database Migration Service
Dataplex
Dataproc
Dataproc Metastore
Datastore
Datastream
Deploy
Dialogflow API
Discovery Engine API
Distributed Edge
Distributed Edge Network API
Document AI
Domains
Essential Contacts API
Eventarc
Filestore API
Firestore
Fleet Routing
Functions
GKE Hub API
IAM
IAM Admin API
IAM Policy Troubleshooter API
IAM Service Account Credentials API
Identity Access Context Manager
Identity-Aware Proxy API
Infrastructure Manager API
Internet of Things (IoT) Core
Intrusion Detection System
Key Management Service
Kubernetes Engine
Logging
Managed Service for Microsoft Active Directory
Memcache
Monitoring Dashboards
Natural Language
Network Connectivity Center
Network Management API
Network Security API
OS Config API
OS Login
Organization Policy
Profiler
Pub/Sub
Pub/Sub Group Kafka Connector
Pub/Sub Lite
Pub/Sub Lite Kafka Shim
Pub/Sub Lite Spark Connector
Public Certificate Authority API
Quotas API
Recommender
Redis
Resource Manager API
Retail
Routes API
Scheduler
Secret Management
Secure Source Manager API
Security Center Management API
Security Command Center
Security Posture API
Security Scanner
Serverless VPC Access
Service Control API
Service Directory
Service Management API
Service Usage
Shell
Spanner
Spanner JDBC
Speech
Stackdriver Monitoring
Stackdriver Trace
Storage
Storage Transfer Service
TPU
Talent Solution
Tasks
Telco Automation API
Text-to-Speech
Translation
VM Migration
Vertex AI
VertexAI API
Video Intelligence
Video Stitcher API
Video Transcoder
Vision
Web Risk
Workflow Executions
Workflows
Workspace Add-ons API
Workstations
reCAPTCHA Enterprise
API hub API
Ad Manager API
Address Validation API
Analytics Admin
Analytics Data
Analytics Hub
Anthos Multicloud
Managed Service for Apache Kafka API
App Hub API
Area 120 Tables
Backup for GKE
Bare Metal Solution
Batch
BeyondCorp AppConnections
BeyondCorp AppConnectors
BeyondCorp AppGateways
BeyondCorp ClientConnectorServices
BeyondCorp ClientGateways
BigLake
BigQuery DataPolicy API
BigQuery Migration
CSS API
Certificate Manager
Chat API
Commerce Consumer Procurement
Confidential Computing API
Connect Gateway API
Data Labeling
Dataflow
Dataform
Developer Connect API
Dialogflow CX
Document AI Warehouse
Enterprise Knowledge Graph
Error Reporting
Eventarc Publishing
GDC Hardware Management API
KMS Inventory API
Life Sciences
Live Stream API
Logging Logback Appender
Logging Servlet Initializer
Maps Platform Datasets API
Marketing Platform Admin API
Media Translation API
Meet API
Memorystore for Redis API
Merchant API
Merchant API
Merchant API
Merchant API
Merchant API
Merchant API
Merchant Conversions API
Merchant LFP API
Merchant Notifications API
Merchant Quota API
Migration Center API
Monitoring Metrics Scopes
NIO Filesystem Provider for Storage
NetApp API
Network Services API
Oracle Database@API
Parallelstore API
Phishing Protection
Places API (New)
Places Insights API
Policy Simulator API
Private Catalog
Privileged Access Manager API
Pub/Sub Lite Flink Connector
Rapid Migration Assessment API
Recommendations AI
Registry API
Route Optimization API
Run
Security Command Center Settings API
Service Health API
Solar API
Storage Insights API
Support API
VMware Engine
Vision AI API
Workspace Events API

If the service is not listed,google-api-java-client interfaces with additional Google Cloud APIs using a legacy REST interface.

When building Java applications, preference should be given to the libraries listed in the table.

This library provides tools to help write tests for code that uses google-cloud services.

SeeTESTING to read more about using our testing helpers.

This library followsSemantic Versioning, with someadditional qualifications:

1. Components marked with@BetaApi or@Experimental are considered to be "0.x"features inside a "1.x" library. This means they can change between minor andpatch releases in incompatible ways. These features should not be used by anylibrary "B" that itself has consumers, unless the components of library B thatuse@BetaApi features are also marked with@BetaApi. Features marked as@BetaApi are on a path to eventually become "1.x" features with the markerremoved.

   Special exception for google-cloud-java: google-cloud-java isallowed to depend on@BetaApi features in gax-java without declaring the consumingcode@BetaApi, because gax-java and google-cloud-java move in stepwith each other. For this reason, gax-java should not be usedindependently of google-cloud-java.

2. Components marked with@InternalApi are technically public, but onlybecause of the limitations of Java's accessmodifiers. For the purposes of semver, they should be considered private.

3. Interfaces marked with@InternalExtensionOnly are public, but should only beimplemented by internal classes. For the purposes of semver, we reserve the rightto add to these interfaces without default implementations (for Java 7).

Please note these clients are currently under active development. Any release versioned 0.x.y issubject to backwards incompatible changes at any time.

Libraries defined at a Stable quality level are expected to be stable and all updates in thelibraries are guaranteed to be backwards-compatible. Any backwards-incompatible changes will leadto the major version increment (1.x.y -> 2.0.0).

Libraries defined at a Preview quality level are still a work-in-progress andare more likely to get backwards-incompatible updates. Additionally, it's possible for Previewlibraries to get deprecated and deleted before ever being promoted to Preview or Stable.

If you're using IntelliJ or Eclipse, you can add client libraries to your project using these IDE plugins:

• Cloud Tools for IntelliJ
• Cloud Tools for Eclipse

Besides adding client libraries, the plugins provide additional functionality, such as service accountkey management. Refer to the documentation for each plugin for more details.

These client libraries can be used on App Engine standard for Java 8 runtime and App Engine flexible(including the Compat runtime). Most of the libraries do not work on the App Engine standard for Java 7runtime. However, Datastore, Storage, and Bigquery should work.

SeeCONTRIBUTING.md.

Apache 2.0 - SeeLICENSE for more information.