Skip to content
Permalink
Browse files
feat: promote to beta (#51)
  • Loading branch information
chingor13 committed Jan 24, 2020
1 parent 38f8a7d commit f265a98de68f83213308df920c3064387202198f
Showing with 119 additions and 122 deletions.
  1. +5 −3 .repo-metadata.json
  2. +111 −60 README.md
  3. +2 −58 synth.metadata
  4. +1 −1 versions.txt
@@ -1,11 +1,13 @@
{
"name": "oslogin",
"name_pretty": "Google Cloud OS Login",
"name_pretty": "Cloud OS Login",
"product_documentation": "https://cloud.google.com/compute/docs/oslogin/",
"client_documentation": "https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/oslogin/v1/package-summary.html",
"client_documentation": "https://googleapis.dev/java/google-cloud-os-login/latest/index.html",
"api_description": "manages OS login configuration for Directory API users.",
"issue_tracker": "https://issuetracker.google.com/savedsearches/559755",
"release_level": "alpha",
"release_level": "beta",
"language": "java",
"transport": "grpc",
"repo": "googleapis/java-os-login",
"repo_short": "java-os-login",
"distribution_name": "com.google.cloud:google-cloud-os-login",
171 README.md
@@ -1,30 +1,52 @@
Google Cloud Java Client for OS Login
=====================================
# Google Cloud OS Login Client for Java

Java idiomatic client for [Google Cloud OS Login][cloud-os-login].
Java idiomatic client for [Cloud OS Login][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-os-login.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-os-login.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][cloud-os-login]
- [Client Library Documentation][os-login-client-lib-docs]
- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
Quickstart
----------
## 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>3.4.0</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>

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

[//]: # ({x-version-update-start:google-cloud-os-login:released})
Add this to your pom.xml file

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

```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-os-login</artifactId>
<version>0.117.1-alpha</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-os-login:0.117.1-alpha'
@@ -35,76 +57,105 @@ libraryDependencies += "com.google.cloud" % "google-cloud-os-login" % "0.117.1-a
```
[//]: # ({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 Google Cloud OS Login
---------------------------
### Prerequisites

[Google Cloud OS Login][cloud-os-login] manages OS login configuration for Directory API users.
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud OS Login [API enabled][enable-api].

See the [OS Login client library docs][os-login-client-lib-docs] to learn how to interact with the
Cloud OS Login using this 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
For this tutorial, you will need a
[Google Developers Console](https://console.developers.google.com/) project with the OS Login API
enabled. You will need to [enable billing](https://support.google.com/cloud/answer/6158867?hl=en) to
use Google Cloud OS Login.
[Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your
project set up. [Set up authentication with a service account][auth] so you can access the
API from your local workstation.
### Installation and setup

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

Transport
---------
OS Login uses gRPC for the transport layer.
## About Cloud OS Login

Java Versions
-------------

Java 7 or above is required for using this client.
[Cloud OS Login][product-docs] manages OS login configuration for Directory API users.

Testing
-------
See [TESTING] to read more about testing.
See the [Cloud OS Login client library docs][javadocs] to learn how to
use this Cloud OS Login Client Library.

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
------------
## Troubleshooting

Contributions to this library are always welcome and highly encouraged.
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

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.
## Transport

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.
Cloud OS Login uses gRPC for the transport layer.

License
-------
## Java Versions

Java 7 or above is required for using this client.

## Versioning

This library follows [Semantic Versioning](http://semver.org/).

Apache 2.0 - See [LICENSE] for more information.

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]: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
[TESTING]: https://github.com/googleapis/google-cloud-java/blob/master/TESTING.md

[cloud-os-login]: https://cloud.google.com/compute/docs/oslogin/rest/
[os-login-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/oslogin/v1/package-summary.html
[auth]: https://cloud.google.com/docs/authentication/getting-started
## 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.

## 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]

[product-docs]: https://cloud.google.com/compute/docs/oslogin/
[javadocs]: https://googleapis.dev/java/google-cloud-os-login/latest/index.html
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-os-login/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-os-login.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-os-login&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-os-login/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-os-login/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-os-login/blob/master/LICENSE

[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=oslogin.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
@@ -1,5 +1,5 @@
{
"updateTime": "2020-01-23T08:55:24.176837Z",
"updateTime": "2020-01-23T21:53:16.950743Z",
"sources": [
{
"generator": {
@@ -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\n"
"sha": "c2cdcd2b08ca35c5054268f6277ea04713c88e39"
}
},
{
@@ -53,9 +51,6 @@
{
"path": ".github/release-please.yml"
},
{
"path": ".gitignore"
},
{
"path": ".kokoro/build.bat"
},
@@ -221,12 +216,6 @@
{
"path": ".kokoro/trampoline.sh"
},
{
"path": ".repo-metadata.json"
},
{
"path": "CHANGELOG.md"
},
{
"path": "CODE_OF_CONDUCT.md"
},
@@ -236,18 +225,9 @@
{
"path": "LICENSE"
},
{
"path": "README.md"
},
{
"path": "codecov.yaml"
},
{
"path": "google-cloud-os-login-bom/pom.xml"
},
{
"path": "google-cloud-os-login/pom.xml"
},
{
"path": "google-cloud-os-login/src/main/java/com/google/cloud/oslogin/v1/OsLoginServiceClient.java"
},
@@ -278,12 +258,6 @@
{
"path": "google-cloud-os-login/src/test/java/com/google/cloud/oslogin/v1/OsLoginServiceClientTest.java"
},
{
"path": "google-cloud-os-login/src/test/java/com/google/cloud/oslogin/v1/it/ITSystemTest.java"
},
{
"path": "grpc-google-cloud-os-login-v1/pom.xml"
},
{
"path": "grpc-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/OsLoginServiceGrpc.java"
},
@@ -293,27 +267,12 @@
{
"path": "license-checks.xml"
},
{
"path": "pom.xml"
},
{
"path": "proto-google-cloud-os-login-v1/clirr-ignored-differences.xml"
},
{
"path": "proto-google-cloud-os-login-v1/pom.xml"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/common/FingerprintName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/common/OsLoginProto.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/common/PosixAccountName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/common/ProjectName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/common/SshPublicKeyName.java"
},
@@ -332,9 +291,6 @@
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/DeleteSshPublicKeyRequestOrBuilder.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/FingerprintName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/GetLoginProfileRequest.java"
},
@@ -371,9 +327,6 @@
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/PosixAccountName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/ProjectName.java"
},
{
"path": "proto-google-cloud-os-login-v1/src/main/java/com/google/cloud/oslogin/v1/SshPublicKeyName.java"
},
@@ -394,15 +347,6 @@
},
{
"path": "renovate.json"
},
{
"path": "synth.metadata"
},
{
"path": "synth.py"
},
{
"path": "versions.txt"
}
]
}
@@ -3,4 +3,4 @@

proto-google-cloud-os-login-v1:0.82.1:0.82.2-SNAPSHOT
grpc-google-cloud-os-login-v1:0.82.1:0.82.2-SNAPSHOT
google-cloud-os-login:0.117.1-alpha:0.117.2-alpha-SNAPSHOT
google-cloud-os-login:0.117.1:0.117.2-SNAPSHOT

0 comments on commit f265a98

Please sign in to comment.