From 32c071ad4cbe80def08277923ccdee7f3ffc4be6 Mon Sep 17 00:00:00 2001 From: Anna Cocuzzo <63511057+acocuzzo@users.noreply.github.com> Date: Mon, 18 Nov 2024 08:48:39 -0500 Subject: [PATCH] fix: official name for java-managedkafka is Managed Service for Apache Kafka API (#11308) * fix: Update java-managedkafka .repo-metadata.json * fix outdated docs --- README.md | 2 +- generation_config.yaml | 2 +- java-managedkafka/.repo-metadata.json | 4 ++-- java-managedkafka/README.md | 20 +++++++++---------- .../google-cloud-managedkafka-bom/pom.xml | 4 ++-- .../google-cloud-managedkafka/pom.xml | 4 ++-- java-managedkafka/pom.xml | 2 +- 7 files changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 8ab837b88966..271dd456695b 100644 --- a/README.md +++ b/README.md @@ -154,7 +154,7 @@ Libraries are available on GitHub and Maven Central for developing Java applicat | [Analytics Data](https://github.com/googleapis/google-cloud-java/tree/main/java-analytics-data) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.analytics/google-analytics-data.svg)](https://search.maven.org/search?q=g:com.google.analytics%20AND%20a:google-analytics-data&core=gav) | | [Analytics Hub](https://github.com/googleapis/google-cloud-java/tree/main/java-bigquery-data-exchange) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigquery-data-exchange.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-bigquery-data-exchange&core=gav) | | [Anthos Multicloud](https://github.com/googleapis/google-cloud-java/tree/main/java-gke-multi-cloud) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-gke-multi-cloud.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-gke-multi-cloud&core=gav) | -| [Apache Kafka for BigQuery API](https://github.com/googleapis/google-cloud-java/tree/main/java-managedkafka) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-managedkafka.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-managedkafka&core=gav) | +| [Managed Service for Apache Kafka API](https://github.com/googleapis/google-cloud-java/tree/main/java-managedkafka) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-managedkafka.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-managedkafka&core=gav) | | [App Hub API](https://github.com/googleapis/google-cloud-java/tree/main/java-apphub) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apphub.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-apphub&core=gav) | | [Area 120 Tables](https://github.com/googleapis/google-cloud-java/tree/main/java-area120-tables) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.area120/google-area120-tables.svg)](https://search.maven.org/search?q=g:com.google.area120%20AND%20a:google-area120-tables&core=gav) | | [Backup for GKE](https://github.com/googleapis/google-cloud-java/tree/main/java-gke-backup) | [![preview][preview-stability]][preview-description] | [![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-gke-backup.svg)](https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-gke-backup&core=gav) | diff --git a/generation_config.yaml b/generation_config.yaml index 7c7e0b1e3e34..5ddbd8ad1ff1 100644 --- a/generation_config.yaml +++ b/generation_config.yaml @@ -1232,7 +1232,7 @@ libraries: - proto_path: google/cloud/managedidentities/v1beta1 - api_shortname: managedkafka - name_pretty: Apache Kafka for BigQuery API + name_pretty: Managed Service for Apache Kafka API product_documentation: https://cloud.google.com/managed-kafka api_description: Manage Apache Kafka clusters and resources. client_documentation: diff --git a/java-managedkafka/.repo-metadata.json b/java-managedkafka/.repo-metadata.json index 16e0c49b6124..c05e668743bb 100644 --- a/java-managedkafka/.repo-metadata.json +++ b/java-managedkafka/.repo-metadata.json @@ -1,6 +1,6 @@ { "api_shortname": "managedkafka", - "name_pretty": "Apache Kafka for BigQuery API", + "name_pretty": "Managed Service for Apache Kafka API", "product_documentation": "https://cloud.google.com/managed-kafka", "api_description": "Manage Apache Kafka clusters and resources.", "client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-managedkafka/latest/overview", @@ -13,4 +13,4 @@ "api_id": "managedkafka.googleapis.com", "library_type": "GAPIC_AUTO", "requires_billing": true -} \ No newline at end of file +} diff --git a/java-managedkafka/README.md b/java-managedkafka/README.md index 08f25a336309..4cd2127e78b4 100644 --- a/java-managedkafka/README.md +++ b/java-managedkafka/README.md @@ -1,6 +1,6 @@ -# Google Apache Kafka for BigQuery API Client for Java +# Managed Service for Apache Kafka API Client for Java -Java idiomatic client for [Apache Kafka for BigQuery API][product-docs]. +Java idiomatic client for [Managed Service for Apache Kafka API][product-docs]. [![Maven][maven-version-image]][maven-version-link] ![Stability][stability-image] @@ -67,14 +67,14 @@ See the [Authentication][authentication] section in the base directory's README. ## Authorization -The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Apache Kafka for BigQuery API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Apache Kafka for BigQuery API API calls. +The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Managed Service for Apache Kafka API APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Managed Service for Apache Kafka API calls. ## Getting Started ### Prerequisites -You will need a [Google Cloud Platform Console][developer-console] project with the Apache Kafka for BigQuery API [API enabled][enable-api]. -You will need to [enable billing][enable-billing] to use Google Apache Kafka for BigQuery API. +You will need a [Google Cloud Platform Console][developer-console] project with the Managed Service for Apache Kafka API [API enabled][enable-api]. +You will need to [enable billing][enable-billing] to use Google Managed Service for Apache Kafka API. [Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud Command Line Interface][cloud-cli] and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`. @@ -84,13 +84,13 @@ You will need to [enable billing][enable-billing] to use Google Apache Kafka for You'll need to obtain the `google-cloud-managedkafka` library. See the [Quickstart](#quickstart) section to add `google-cloud-managedkafka` as a dependency in your code. -## About Apache Kafka for BigQuery API +## About Managed Service for Apache Kafka API -[Apache Kafka for BigQuery API][product-docs] Manage Apache Kafka clusters and resources. +[Managed Service for Apache Kafka API][product-docs] Manage Apache Kafka clusters and resources. -See the [Apache Kafka for BigQuery API client library docs][javadocs] to learn how to -use this Apache Kafka for BigQuery API Client Library. +See the [Managed Service for Apache Kafka API client library docs][javadocs] to learn how to +use this Managed Service for Apache Kafka API Client Library. @@ -103,7 +103,7 @@ To get help, follow the instructions in the [shared Troubleshooting document][tr ## Transport -Apache Kafka for BigQuery API uses both gRPC and HTTP/JSON for the transport layer. +Managed Service for Apache Kafka API uses both gRPC and HTTP/JSON for the transport layer. ## Supported Java Versions diff --git a/java-managedkafka/google-cloud-managedkafka-bom/pom.xml b/java-managedkafka/google-cloud-managedkafka-bom/pom.xml index a4c771c48b6c..ba2a438efa34 100644 --- a/java-managedkafka/google-cloud-managedkafka-bom/pom.xml +++ b/java-managedkafka/google-cloud-managedkafka-bom/pom.xml @@ -12,9 +12,9 @@ ../../google-cloud-pom-parent/pom.xml - Google Apache Kafka for BigQuery API BOM + Google Managed Service for Apache Kafka API BOM - BOM for Apache Kafka for BigQuery API + BOM for Managed Service for Apache Kafka API diff --git a/java-managedkafka/google-cloud-managedkafka/pom.xml b/java-managedkafka/google-cloud-managedkafka/pom.xml index ab58f47b8a8e..eebe78f6e48e 100644 --- a/java-managedkafka/google-cloud-managedkafka/pom.xml +++ b/java-managedkafka/google-cloud-managedkafka/pom.xml @@ -5,8 +5,8 @@ google-cloud-managedkafka 0.10.0-SNAPSHOT jar - Google Apache Kafka for BigQuery API - Apache Kafka for BigQuery API Manage Apache Kafka clusters and resources. + Google Managed Service for Apache Kafka API + Managed Service for Apache Kafka API Manage Apache Kafka clusters and resources. com.google.cloud google-cloud-managedkafka-parent diff --git a/java-managedkafka/pom.xml b/java-managedkafka/pom.xml index 76a5500c0ec3..862c83cfdba2 100644 --- a/java-managedkafka/pom.xml +++ b/java-managedkafka/pom.xml @@ -5,7 +5,7 @@ google-cloud-managedkafka-parent pom 0.10.0-SNAPSHOT - Google Apache Kafka for BigQuery API Parent + Google Managed Service for Apache Kafka API Parent Java idiomatic client for Google Cloud Platform services.