-
Notifications
You must be signed in to change notification settings - Fork 1.2k
feat(apptopology): onboard a new library #14204
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
noahdietz
wants to merge
2
commits into
main
Choose a base branch
from
onboard-apptopology
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| { | ||
| "api_shortname": "apptopology", | ||
| "name_pretty": "App Topology", | ||
| "product_documentation": "https://docs.cloud.google.com/app-topology", | ||
| "api_description": "", | ||
| "client_documentation": "https://cloud.google.com/java/docs/reference/google-cloud-apptopology/latest/overview", | ||
| "release_level": "preview", | ||
| "transport": "grpc+rest", | ||
| "language": "java", | ||
| "repo": "googleapis/google-cloud-java", | ||
| "repo_short": "java-apptopology", | ||
| "distribution_name": "com.google.cloud:google-cloud-apptopology", | ||
| "api_id": "apptopology.googleapis.com", | ||
| "library_type": "GAPIC_AUTO" | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,210 @@ | ||
| # Google App Topology Client for Java | ||
|
|
||
| Java idiomatic client for [App Topology][product-docs]. | ||
|
|
||
| [![Maven][maven-version-image]][maven-version-link] | ||
| ![Stability][stability-image] | ||
|
|
||
| - [Product Documentation][product-docs] | ||
| - [Client Library Documentation][javadocs] | ||
|
|
||
| > Note: This client is a work-in-progress, and may occasionally | ||
| > make backwards-incompatible changes. | ||
|
|
||
|
|
||
| ## Quickstart | ||
|
|
||
| If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file: | ||
|
|
||
| ```xml | ||
| <dependencyManagement> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>libraries-bom</artifactId> | ||
| <version>26.86.0</version> | ||
| <type>pom</type> | ||
| <scope>import</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| </dependencyManagement> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-apptopology</artifactId> | ||
| </dependency> | ||
| </dependencies> | ||
| ``` | ||
|
|
||
| If you are using Maven without the BOM, add this to your dependencies: | ||
|
|
||
|
|
||
| ```xml | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-apptopology</artifactId> | ||
| <version>0.0.0</version> | ||
| </dependency> | ||
| ``` | ||
|
|
||
| If you are using Gradle 5.x or later, add this to your dependencies: | ||
|
|
||
| ```Groovy | ||
| implementation platform('com.google.cloud:libraries-bom:26.86.0') | ||
|
|
||
| implementation 'com.google.cloud:google-cloud-apptopology' | ||
| ``` | ||
|
|
||
| If you are using Gradle without BOM, add this to your dependencies: | ||
|
|
||
| ```Groovy | ||
| implementation 'com.google.cloud:google-cloud-apptopology:0.0.0' | ||
| ``` | ||
|
|
||
| If you are using SBT, add this to your dependencies: | ||
|
|
||
| ```Scala | ||
| libraryDependencies += "com.google.cloud" % "google-cloud-apptopology" % "0.0.0" | ||
| ``` | ||
|
|
||
| ## Authentication | ||
|
|
||
| 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 App Topology APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the App Topology API calls. | ||
|
|
||
| ## Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| You will need a [Google Cloud Platform Console][developer-console] project with the App Topology [API enabled][enable-api]. | ||
| You will need to [enable billing][enable-billing] to use Google App Topology. | ||
| [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]`. | ||
|
|
||
| ### Installation and setup | ||
|
|
||
| You'll need to obtain the `google-cloud-apptopology` library. See the [Quickstart](#quickstart) section | ||
| to add `google-cloud-apptopology` as a dependency in your code. | ||
|
|
||
| ## About App Topology | ||
|
|
||
|
|
||
| [App Topology][product-docs] | ||
|
|
||
| See the [App Topology client library docs][javadocs] to learn how to | ||
| use this App Topology Client Library. | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ## Troubleshooting | ||
|
|
||
| To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting]. | ||
|
|
||
| ## Transport | ||
|
|
||
| App Topology uses both gRPC and HTTP/JSON for the transport layer. | ||
|
|
||
| ## Supported Java Versions | ||
|
|
||
| Java 8 or above is required for using this client. | ||
|
|
||
| Google's Java client libraries, | ||
| [Google Cloud Client Libraries][cloudlibs] | ||
| and | ||
| [Google Cloud API Libraries][apilibs], | ||
| follow the | ||
| [Oracle Java SE support roadmap][oracle] | ||
| (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][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][g-c-j]. | ||
|
|
||
| ## Versioning | ||
| This library follows [Semantic Versioning](http://semver.org/). | ||
|
|
||
|
|
||
| It is currently in major version zero (``0.y.z``), which means that anything may change at any time | ||
| and the public API should not be considered stable. | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
|
|
||
| Contributions to this library are always welcome and highly encouraged. | ||
|
|
||
| See [CONTRIBUTING][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][code-of-conduct] for more | ||
| information. | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| Apache 2.0 - See [LICENSE][license] for more information. | ||
|
|
||
| Java is a registered trademark of Oracle and/or its affiliates. | ||
|
|
||
| [product-docs]: https://docs.cloud.google.com/app-topology | ||
| [javadocs]: https://cloud.google.com/java/docs/reference/google-cloud-apptopology/latest/overview | ||
| [stability-image]: https://img.shields.io/badge/stability-preview-yellow | ||
| [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-apptopology.svg | ||
| [maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-apptopology/0.0.0 | ||
| [authentication]: https://github.com/googleapis/google-cloud-java#authentication | ||
| [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes | ||
| [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles | ||
| [iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy | ||
| [developer-console]: https://console.developers.google.com/ | ||
| [create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects | ||
| [cloud-cli]: https://cloud.google.com/cli | ||
| [troubleshooting]: https://github.com/googleapis/google-cloud-java/blob/main/TROUBLESHOOTING.md | ||
| [contributing]: https://github.com/googleapis/google-cloud-java/blob/main/CONTRIBUTING.md | ||
| [code-of-conduct]: https://github.com/googleapis/google-cloud-java/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct | ||
| [license]: https://github.com/googleapis/google-cloud-java/blob/main/LICENSE | ||
| [enable-billing]: https://cloud.google.com/apis/docs/getting-started#enabling_billing | ||
| [enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=apptopology.googleapis.com | ||
| [libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM | ||
| [shell_img]: https://gstatic.com/cloudssh/images/open-btn.png | ||
|
|
||
| [semver]: https://semver.org/ | ||
| [cloudlibs]: https://cloud.google.com/apis/docs/client-libraries-explained | ||
| [apilibs]: https://cloud.google.com/apis/docs/client-libraries-explained#google_api_client_libraries | ||
| [oracle]: https://www.oracle.com/java/technologies/java-se-support-roadmap.html | ||
| [g-c-j]: http://github.com/googleapis/google-cloud-java |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| <?xml version='1.0' encoding='UTF-8'?> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-apptopology-bom</artifactId> | ||
| <version>0.1.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-apptopology:current} --> | ||
| <packaging>pom</packaging> | ||
| <parent> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-pom-parent</artifactId> | ||
| <version>1.91.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-pom-parent:current} --> | ||
| <relativePath>../../google-cloud-pom-parent/pom.xml</relativePath> | ||
| </parent> | ||
|
|
||
| <name>Google App Topology BOM</name> | ||
| <description> | ||
| BOM for App Topology | ||
| </description> | ||
|
|
||
| <properties> | ||
| <maven.antrun.skip>true</maven.antrun.skip> | ||
| </properties> | ||
|
|
||
| <dependencyManagement> | ||
| <dependencies> | ||
| <!-- {x-generated-dependencies-start} --> | ||
| <dependency> | ||
| <groupId>com.google.cloud</groupId> | ||
| <artifactId>google-cloud-apptopology</artifactId> | ||
| <version>0.1.0-SNAPSHOT</version><!-- {x-version-update:google-cloud-apptopology:current} --> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.google.api.grpc</groupId> | ||
| <artifactId>grpc-google-cloud-apptopology-v1</artifactId> | ||
| <version>0.1.0-SNAPSHOT</version><!-- {x-version-update:grpc-google-cloud-apptopology-v1:current} --> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.google.api.grpc</groupId> | ||
| <artifactId>proto-google-cloud-apptopology-v1</artifactId> | ||
| <version>0.1.0-SNAPSHOT</version><!-- {x-version-update:proto-google-cloud-apptopology-v1:current} --> | ||
| </dependency> | ||
| <!-- {x-generated-dependencies-end} --> | ||
| </dependencies> | ||
| </dependencyManagement> | ||
| </project> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
api_descriptionfield is currently empty. Populating this field with a brief description of the App Topology service automatically populates the "About App Topology" section in the generatedREADME.md, which currently contains a broken/incomplete sentence[App Topology][product-docs].