- 1.61.0 (latest)
- 1.60.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.48.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.36.0
- 1.35.0
- 1.34.0
- 1.33.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.0
- 1.11.0
- 1.10.0
- 1.9.5
- 1.8.4
- 1.7.2
- 1.6.2
- 1.5.4
Google Data Catalog Client for Java
Java idiomatic client for Data Catalog.
Quickstart
If you are using Maven with BOM, add this to your pom.xml file
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>22.0.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-datacatalog</artifactId>
</dependency>
If you are using Maven without BOM, add this to your dependencies:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-datacatalog</artifactId>
<version>1.5.3</version>
</dependency>
If you are using Gradle 5.x or later, add this to your dependencies
implementation platform('com.google.cloud:libraries-bom:22.0.0')
implementation 'com.google.cloud:google-cloud-datacatalog'
If you are using Gradle without BOM, add this to your dependencies
implementation 'com.google.cloud:google-cloud-datacatalog:1.5.3'
If you are using SBT, add this to your dependencies
libraryDependencies += "com.google.cloud" % "google-cloud-datacatalog" % "1.5.3"
Authentication
See the Authentication section in the base directory's README.
Authorization
The client application making API calls must be granted authorization scopes required for the desired Data Catalog APIs, and the authenticated principal must have the IAM role(s) required to access GCP resources using the Data Catalog API calls.
Getting Started
Prerequisites
You will need a Google Cloud Platform Console project with the Data Catalog API enabled.
You will need to enable billing to use Google Data Catalog.
Follow these instructions to get your project set up. You will also need to set up the local development environment by
installing the Google Cloud SDK and running the following commands in command line:
gcloud auth login
and gcloud config set project [YOUR PROJECT ID]
.
Installation and setup
You'll need to obtain the google-cloud-datacatalog
library. See the Quickstart section
to add google-cloud-datacatalog
as a dependency in your code.
About Data Catalog
Data Catalog is a fully managed and highly scalable data discovery and metadata management service.
See the Data Catalog client library docs to learn how to use this Data Catalog Client Library.
Samples
Samples are in the samples/
directory.
Sample | Source Code | Try it |
---|---|---|
None | source code | |
None | source code | |
None | source code | |
None | source code | |
Create Custom Entry | source code | |
Create Entry | source code | |
Create Entry Group | source code | |
Create Fileset Entry | source code | |
Create Tag Template | source code | |
Delete Entry | source code | |
Delete Entry Group | source code | |
Delete Tag Template | source code | |
Get Entry | source code | |
Get Entry Group | source code | |
Get Tag Template | source code | |
Grant Tag Template User Role | source code | |
List Entries | source code | |
List Entry Groups | source code | |
Lookup Entry Big Query Dataset | source code | |
Lookup Entry Big Query Table | source code | |
Lookup Entry Pub Sub Topic | source code | |
Quickstart | source code | |
Search Assets | source code | |
Update Entry | source code | |
Update Entry Group | source code | |
Update Tag Template | source code |
Troubleshooting
To get help, follow the instructions in the shared Troubleshooting document.
Transport
Data Catalog uses gRPC for the transport layer.
Supported Java Versions
Java 7 or above is required for using this client.
Google's Java client libraries, Google Cloud Client Libraries and Google Cloud API Libraries, follow the Oracle Java SE support roadmap (see the Oracle Java SE Product Releases section).
For new development
In general, new feature development occurs with support for the lowest Java LTS version covered by Oracle's Premier Support (which typically lasts 5 years from initial General Availability). If the minimum required JVM for a given library is changed, it is accompanied by a semver major release.
Java 11 and (in September 2021) Java 17 are the best choices for new development.
Keeping production systems current
Google tests its client libraries with all current LTS versions covered by Oracle's Extended Support (which typically lasts 8 years from initial General Availability).
Legacy support
Google's client libraries support legacy versions of Java runtimes with long term stable libraries that don't receive feature updates on a best efforts basis as it may not be possible to backport all patches.
Google provides updates on a best efforts basis to apps that continue to use Java 7, though apps might need to upgrade to current versions of the library that supports their JVM.
Where to find specific information
The latest versions and the supported Java versions are identified on
the individual GitHub repository github.com/GoogleAPIs/java-SERVICENAME
and on google-cloud-java.
Versioning
This library follows Semantic Versioning.
Contributing
Contributions to this library are always welcome and highly encouraged.
See CONTRIBUTING for more information 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
Apache 2.0 - See LICENSE for more information.
CI Status
Java is a registered trademark of Oracle and/or its affiliates.