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

feat: promote to GA #59

Merged
merged 2 commits into from Jan 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion .kokoro/release/publish_javadoc.sh
Expand Up @@ -33,7 +33,7 @@ python3 -m pip install gcp-docuploader
# compile all packages
mvn clean install -B -DskipTests=true

NAME=google-cloud-videointelligence
NAME=google-cloud-video-intelligence
VERSION=$(grep ${NAME}: versions.txt | cut -d: -f3)

# build the docs
Expand Down
7 changes: 4 additions & 3 deletions .repo-metadata.json
Expand Up @@ -2,12 +2,13 @@
"name": "videointelligence",
kolea2 marked this conversation as resolved.
Show resolved Hide resolved
"name_pretty": "Cloud Video Intelligence",
"product_documentation": "https://cloud.google.com/video-intelligence/docs/",
"client_documentation": "https://googleapis.dev/java/java-video-intelligence/latest/",
"client_documentation": "https://googleapis.dev/java/google-cloud-video-intelligence/latest/",
"api_description": "allows developers to use Google video analysis technology as part of their applications.",
"issue_tracker": "https://issuetracker.google.com/savedsearches/5084810",
"release_level": "beta",
"release_level": "ga",
"language": "java",
"repo": "googleapis/java-video-intelligence",
"repo_short": "java-video-intelligence",
"distribution_name": "com.google.cloud:google-cloud-videointelligence",
"distribution_name": "com.google.cloud:google-cloud-video-intelligence",
"api_id": "videointelligence.googleapis.com"
}
173 changes: 101 additions & 72 deletions README.md
@@ -1,48 +1,49 @@
Google Cloud Java Client for Video Intelligence
======================================
# Google Cloud Video Intelligence Client for Java

Java idiomatic client for [Google Cloud Video Intelligence][cloud-video-intelligence].
Java idiomatic client for [Cloud Video Intelligence][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-video-intelligence.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-video-intelligence.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][video-product-docs]
- [Client Library Documentation][video-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 a BOM, add this to your pom.xml file.
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-video-intelligence</artifactId>
</dependency>
<dependencies>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-video-intelligence</artifactId>
</dependency>
</dependencies>
```

[//]: # ({x-version-update-start:google-cloud-video-intelligence: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-video-intelligence</artifactId>
<version>0.116.2-beta</version>
</dependency>
```

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-video-intelligence:0.116.2-beta'
Expand All @@ -53,70 +54,98 @@ libraryDependencies += "com.google.cloud" % "google-cloud-video-intelligence" %
```
[//]: # ({x-version-update-end})

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

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

About Google Cloud Video Intelligence
----------------------------
## Getting Started

Google [Cloud Video Intelligence API][cloud-video-intelligence]
allows developers to use Google video analysis technology as part of their applications.
### Prerequisites

See the [Video Intelligence client library docs][video-client-lib-docs]
to learn how to use this Cloud Video Intelligence API Client Library.
You will need a [Google Cloud Platform Console][developer-console] project with the Cloud Video Intelligence [API enabled][enable-api].

Getting Started
---------------
#### Prerequisites
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Video Intelligence 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]`.
[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]`.

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

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

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

Transport
---------
Video Intelligence uses gRPC for the transport layer.

Java Versions
-------------
[Cloud Video Intelligence][product-docs] allows developers to use Google video analysis technology as part of their applications.

Java 7 or above is required for using this client.
See the [Cloud Video Intelligence client library docs][javadocs] to learn how to
use this Cloud Video Intelligence 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.
## Java Versions

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.
Java 7 or above is required for using this client.

License
-------
## Versioning

Apache 2.0 - See [LICENSE] for more information.
This library follows [Semantic Versioning](http://semver.org/).


[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/
[cloud-video-intelligence]: https://cloud.google.com/video-intelligence/
[video-product-docs]: https://cloud.google.com/video-intelligence/docs/
[video-client-lib-docs]: https://googleapis.dev/java/google-cloud-clients/latest/index.html?com/google/cloud/videointelligence/v1/package-summary.html

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

[enable-api]: https://console.cloud.google.com/flows/enableapi?apiid=videointelligence.googleapis.com
[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM