Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
feat: release as beta (#52)
  • Loading branch information
chingor13 committed Jan 24, 2020
1 parent 6af3c47 commit 5d44d18
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 106 deletions.
6 changes: 4 additions & 2 deletions .repo-metadata.json
Expand Up @@ -2,10 +2,12 @@
"name": "iamcredentials",
"name_pretty": "IAM Service Account Credentials API",
"product_documentation": "https://cloud.google.com/iam/credentials/reference/rest/",
"client_documentation": "https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/asset/v1beta1/package-summary.html",
"client_documentation": "https://googleapis.dev/java/google-cloud-iamcredentials/latest/index.html",
"api_description": "creates short-lived, limited-privilege credentials for IAM service accounts.",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=187161&template=0",
"release_level": "alpha",
"release_level": "beta",
"language": "java",
"transport": "grpc",
"repo": "googleapis/java-iamcredentials",
"repo_short": "java-iamcredentials",
"distribution_name": "com.google.cloud:google-cloud-iamcredentials",
Expand Down
164 changes: 103 additions & 61 deletions README.md
@@ -1,49 +1,52 @@
Google Cloud Java Client for IAM Service Account Credentials API
===================================================
# Google IAM Service Account Credentials API Client for Java

Java idiomatic client for [IAM Service Account Credentials API][product-overview].
Java idiomatic client for [IAM Service Account Credentials API][product-docs].

[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/google-cloud-java/master.html)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-iamcredentials.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-iamcredentials.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][product-docs]
- [Client Library Documentation][lib-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 a BOM, add this to your pom.xml file.
## 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>2.8.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>libraries-bom</artifactId>
<version>3.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-iamcredentials</artifactId>
</dependency>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-iamcredentials</artifactId>
</dependency>
</dependencies>
```

[//]: # ({x-version-update-start:google-cloud-iamcredentials:released})
If you are using Maven without a BOM, add this to your dependencies.

If you are using Maven without BOM, add this to your dependencies:

```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-iamcredentials</artifactId>
<version>0.43.1-alpha</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-iamcredentials:0.43.1-alpha'
Expand All @@ -54,66 +57,105 @@ libraryDependencies += "com.google.cloud" % "google-cloud-iamcredentials" % "0.4
```
[//]: # ({x-version-update-end})

Authentication
--------------
## Authentication

See the [Authentication][authentication] section in the base directory's README.

See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
## Getting Started

About IAM Service Account Credentials API
----------------------------
### Prerequisites

Creates short-lived, limited-privilege credentials for IAM service accounts.
You will need a [Google Cloud Platform Console][developer-console] project with the IAM Service Account Credentials API [API enabled][enable-api].

See the [IAM Service Account Credentials API client library docs][lib-docs] to learn how to use this IAM Service Account Credentials Client Library.
[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 SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

Getting Started
---------------
#### Prerequisites
You will need a [Google Developers Console](https://console.developers.google.com/) project with the IAM Service Account Credentials API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
### Installation and setup

#### Installation and setup
You'll need to obtain the `google-cloud-iamcredentials` library. See the [Quickstart](#quickstart) section to add `google-cloud-iamcredentials` as a dependency in your code.
You'll need to obtain the `google-cloud-iamcredentials` library. See the [Quickstart](#quickstart) section
to add `google-cloud-iamcredentials` as a dependency in your code.

Troubleshooting
---------------
## About IAM Service Account Credentials API

To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).

Transport
---------
IAM Service Account Credentials Client uses gRPC for the transport layer.
[IAM Service Account Credentials API][product-docs] creates short-lived, limited-privilege credentials for IAM service accounts.

Java Versions
-------------
See the [IAM Service Account Credentials API client library docs][javadocs] to learn how to
use this IAM Service Account Credentials API Client Library.




## Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

## Transport

IAM Service Account Credentials API uses gRPC for the transport layer.

## Java Versions

Java 7 or above is required for using this client.

Versioning
----------
## 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
------------
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 `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
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.

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

License
-------
Apache 2.0 - See [LICENSE][license] for more information.

Apache 2.0 - See [LICENSE] for more information.
## CI Status

Java Version | Status
------------ | ------
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

[CONTRIBUTING]:https://github.com/googleapis/google-cloud-java/blob/master/CONTRIBUTING.md
[code-of-conduct]:https://github.com/googleapis/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/googleapis/google-cloud-java/blob/master/LICENSE
[cloud-platform]: https://cloud.google.com/
[product-overview]: https://cloud.google.com/iam/credentials/reference/rest/
[product-docs]: https://cloud.google.com/iam/credentials/reference/rest/
[lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/iamcredentials/v1/package-summary.html
[javadocs]: https://googleapis.dev/java/google-cloud-iamcredentials/latest/index.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-iamcredentials/java11.html
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-iamcredentials.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-iamcredentials&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-iamcredentials/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-iamcredentials/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-iamcredentials/blob/master/LICENSE

[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=iamcredentials.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
42 changes: 2 additions & 40 deletions synth.metadata
@@ -1,5 +1,5 @@
{
"updateTime": "2020-01-23T08:46:59.431242Z",
"updateTime": "2020-01-23T21:58:34.134532Z",
"sources": [
{
"generator": {
Expand All @@ -12,9 +12,7 @@
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
"sha": "8d16f76de065f530d395a4c7eabbf766d6a120fd",
"internalRef": "291008516",
"log": "8d16f76de065f530d395a4c7eabbf766d6a120fd\nGenerate Memcache v1beta2 API protos and gRPC ServiceConfig files\n\nPiperOrigin-RevId: 291008516\n\n3af1dabd93df9a9f17bf3624d3b875c11235360b\ngrafeas: Add containeranalysis default_host to Grafeas service\n\nPiperOrigin-RevId: 290965849\n\nbe2663fa95e31cba67d0cd62611a6674db9f74b7\nfix(google/maps/roads): add missing opening bracket\n\nPiperOrigin-RevId: 290964086\n\nfacc26550a0af0696e0534bc9cae9df14275aa7c\nUpdating v2 protos with the latest inline documentation (in comments) and adding a per-service .yaml file.\n\nPiperOrigin-RevId: 290952261\n\ncda99c1f7dc5e4ca9b1caeae1dc330838cbc1461\nChange api_name to 'asset' for v1p1beta1\n\nPiperOrigin-RevId: 290800639\n\n94e9e90c303a820ce40643d9129e7f0d2054e8a1\nAdds Google Maps Road service\n\nPiperOrigin-RevId: 290795667\n\na3b23dcb2eaecce98c600c7d009451bdec52dbda\nrpc: new message ErrorInfo, other comment updates\n\nPiperOrigin-RevId: 290781668\n\n26420ef4e46c37f193c0fbe53d6ebac481de460e\nAdd proto definition for Org Policy v1.\n\nPiperOrigin-RevId: 290771923\n\n7f0dab8177cf371ae019a082e2512de7ac102888\nPublish Routes Preferred API v1 service definitions.\n\nPiperOrigin-RevId: 290326986\n\nad6e508d0728e1d1bca6e3f328cd562718cb772d\nFix: Qualify resource type references with \"jobs.googleapis.com/\"\n\nPiperOrigin-RevId: 290285762\n\n58e770d568a2b78168ddc19a874178fee8265a9d\ncts client library\n\nPiperOrigin-RevId: 290146169\n\naf9daa4c3b4c4a8b7133b81588dd9ffd37270af2\nAdd more programming language options to public proto\n\nPiperOrigin-RevId: 290144091\n\nd9f2bbf2df301ef84641d4cec7c828736a0bd907\ntalent: add missing resource.proto dep to Bazel build target\n\nPiperOrigin-RevId: 290143164\n\n3b3968237451d027b42471cd28884a5a1faed6c7\nAnnotate Talent API.\nAdd gRPC service config for retry.\nUpdate bazel file with google.api.resource dependency.\n\nPiperOrigin-RevId: 290125172\n\n"
"sha": "c2cdcd2b08ca35c5054268f6277ea04713c88e39"
}
},
{
Expand Down Expand Up @@ -53,9 +51,6 @@
{
"path": ".github/release-please.yml"
},
{
"path": ".gitignore"
},
{
"path": ".kokoro/build.bat"
},
Expand Down Expand Up @@ -221,12 +216,6 @@
{
"path": ".kokoro/trampoline.sh"
},
{
"path": ".repo-metadata.json"
},
{
"path": "CHANGELOG.md"
},
{
"path": "CODE_OF_CONDUCT.md"
},
Expand All @@ -236,18 +225,9 @@
{
"path": "LICENSE"
},
{
"path": "README.md"
},
{
"path": "codecov.yaml"
},
{
"path": "google-cloud-iamcredentials-bom/pom.xml"
},
{
"path": "google-cloud-iamcredentials/pom.xml"
},
{
"path": "google-cloud-iamcredentials/src/main/java/com/google/cloud/iam/credentials/v1/IamCredentialsClient.java"
},
Expand Down Expand Up @@ -278,9 +258,6 @@
{
"path": "google-cloud-iamcredentials/src/test/java/com/google/cloud/iam/credentials/v1/MockIAMCredentialsImpl.java"
},
{
"path": "grpc-google-cloud-iamcredentials-v1/pom.xml"
},
{
"path": "grpc-google-cloud-iamcredentials-v1/src/main/java/com/google/cloud/iam/credentials/v1/IAMCredentialsGrpc.java"
},
Expand All @@ -290,12 +267,6 @@
{
"path": "license-checks.xml"
},
{
"path": "pom.xml"
},
{
"path": "proto-google-cloud-iamcredentials-v1/pom.xml"
},
{
"path": "proto-google-cloud-iamcredentials-v1/src/main/java/com/google/cloud/iam/credentials/v1/GenerateAccessTokenRequest.java"
},
Expand Down Expand Up @@ -361,15 +332,6 @@
},
{
"path": "renovate.json"
},
{
"path": "synth.metadata"
},
{
"path": "synth.py"
},
{
"path": "versions.txt"
}
]
}
6 changes: 3 additions & 3 deletions versions.txt
@@ -1,6 +1,6 @@
# Format:
# module:released-version:current-version

proto-google-cloud-iamcredentials-v1:0.43.1-alpha:0.43.2-alpha-SNAPSHOT
grpc-google-cloud-iamcredentials-v1:0.43.1-alpha:0.43.2-alpha-SNAPSHOT
google-cloud-iamcredentials:0.43.1-alpha:0.43.2-alpha-SNAPSHOT
proto-google-cloud-iamcredentials-v1:0.43.1:0.43.2-SNAPSHOT
grpc-google-cloud-iamcredentials-v1:0.43.1:0.43.2-SNAPSHOT
google-cloud-iamcredentials:0.43.1:0.43.2-SNAPSHOT

0 comments on commit 5d44d18

Please sign in to comment.