Skip to content

Commit 96a4f82

Browse files
shinfanshinfan
committed
Add minimum documentation for GAPIC-only clients
1 parent 15b8902 commit 96a4f82

1 file changed

Lines changed: 153 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 153 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,25 +14,31 @@ Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
1414

1515
This client supports the following Google Cloud Platform services at a [Beta](#versioning) quality level:
1616

17-
- [Google Cloud BigQuery](#google-cloud-bigquery-beta) (Beta)
17+
- [BigQuery](#google-cloud-bigquery-beta) (Beta)
1818
- [Stackdriver Logging](#stackdriver-logging-beta) (Beta - Not working on App Engine Standard)
19-
- [Google Cloud Datastore](#google-cloud-datastore-beta) (Beta)
20-
- [Google Cloud Storage](#google-cloud-storage-beta) (Beta)
21-
- [Cloud Spanner](#cloud-spanner-beta) (Beta)
22-
- [Google Cloud Translation](#google-translation-beta) (Beta)
23-
- Cloud Vision (Beta)
24-
- Cloud Natural Language (Beta)
19+
- [Datastore](#google-cloud-datastore-beta) (Beta)
20+
- [Storage](#google-cloud-storage-beta) (Beta)
21+
- [Spanner](#cloud-spanner-beta) (Beta)
2522

2623
This client supports the following Google Cloud Platform services at an [Alpha](#versioning) quality level:
2724

28-
- [Google Cloud Compute](#google-cloud-compute-alpha) (Alpha)
29-
- [Google Cloud DNS](#google-cloud-dns-alpha) (Alpha)
30-
- [Google Cloud Pub/Sub](#google-cloud-pubsub-alpha) (Alpha - Not working on App Engine Standard)
31-
- [Google Cloud Resource Manager](#google-cloud-resource-manager-alpha) (Alpha)
25+
- [Compute](#google-cloud-compute-alpha) (Alpha)
26+
- [DNS](#google-cloud-dns-alpha) (Alpha)
27+
- [Errorreporting](#google-cloud-errorreporting-alpha) (Alpha)
28+
- [Language](#google-cloud-language-alpha) (Alpha)
29+
- [Monitoring](#google-cloud-monitoring-alpha) (Alpha)
30+
- [Pub/Sub](#google-cloud-pubsub-alpha) (Alpha - Not working on App Engine Standard)
31+
- [Resource Manager](#google-cloud-resource-manager-alpha) (Alpha)
32+
- [Speech](#google-cloud-speech-alpha) (Alpha)
33+
- [Trace](#google-cloud-trace-alpha) (Alpha)
34+
- [Translation](#google-translation-beta) (Alpha)
35+
- [Vision](#google-cloud-vision-alpha) (Alpha)
3236

3337
> Note: This client is a work-in-progress, and may occasionally
3438
> make backwards-incompatible changes.
3539
40+
> Note: GAE standard for Java 7 is not supported for gRPC-based clients.
41+
3642
## Where did `gcloud-java` go?
3743

3844
`gcloud-java` lives on under a new name, `google-cloud`.
@@ -573,9 +579,57 @@ ChangeRequestInfo changeRequest = changeBuilder.build();
573579
zone.applyChangeRequest(changeRequest);
574580
```
575581
576-
Google Cloud Pub/Sub (Alpha)
582+
Google Cloud Errorreporting (Alpha)
583+
----------------------
584+
- [API Documentation][errorreporting-api]
585+
- [Official Documentation][cloud-errorreporting-docs]
586+
587+
### Preview
588+
589+
Here is a code snippet showing a simple usage example of ErrorGroupServiceClient.
590+
Note that you must [supply credentials](#authentication) and a project ID if running this
591+
```java
592+
try (ErrorGroupServiceClient errorGroupServiceClient = ErrorGroupServiceClient.create()) {
593+
GroupName groupName = GroupName.create("[PROJECT]", "[GROUP]");
594+
ErrorGroup response = errorGroupServiceClient.getGroup(groupName);
595+
}
596+
```
597+
598+
Google Cloud Language (Alpha)
599+
----------------------
600+
- [API Documentation][language-api]
601+
- [Official Documentation][cloud-language-docs]
602+
603+
### Preview
604+
605+
Here is a code snippet showing a simple usage example of LanguageServiceClient. The example assumes that either default application
606+
credentials or a valid api key are available. (See [Authentication section](#authentication) for more information)
607+
```java
608+
try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
609+
Document document = Document.newBuilder().build();
610+
AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
611+
}
612+
```
613+
614+
Google Cloud Monitoring (Alpha)
577615
----------------------
616+
- [API Documentation][monitoring-api]
617+
- [Official Documentation][cloud-monitoring-docs]
618+
619+
### Preview
620+
621+
Here is a code snippet showing a simple usage example of MetricServiceClient.
622+
Note that you must [supply credentials](#authentication) and a project ID if running this
623+
```java
624+
try (MetricServiceClient metricServiceClient = MetricServiceClient.create()) {
625+
MonitoredResourceDescriptorName name =
626+
MonitoredResourceDescriptorName.create("[PROJECT]", "[MONITORED_RESOURCE_DESCRIPTOR]");
627+
MonitoredResourceDescriptor response = metricServiceClient.getMonitoredResourceDescriptor(name);
628+
}
629+
```
578630
631+
Google Cloud Pub/Sub (Alpha)
632+
----------------------
579633
- [API Documentation][pubsub-api]
580634
- [Official Documentation][cloud-pubsub-docs]
581635
@@ -648,7 +702,7 @@ while (projectIterator.hasNext()) {
648702
}
649703
```
650704
651-
Google Translation (Beta)
705+
Google Translation (Alpha)
652706
----------------
653707
654708
- [API Documentation][translate-api]
@@ -683,6 +737,73 @@ Translation translation = translate.translate(
683737
System.out.printf("Hola %s%n", translation.getTranslatedText());
684738
```
685739
740+
Google Cloud Speech (Alpha)
741+
----------------
742+
743+
- [API Documentation][speech-api]
744+
- [Official Documentation][cloud-speech-docs]
745+
746+
### Preview
747+
748+
Here is a code snippet showing a simple usage example of SpeechClient. The example assumes that either default application
749+
credentials or a valid api key are available. (See [Authentication section](#authentication) for more information)
750+
Note that you must provide a uri to a FLAC audio file to run this.
751+
752+
```java
753+
try (SpeechClient speechClient = SpeechClient.create()) {
754+
RecognitionConfig.AudioEncoding encoding = RecognitionConfig.AudioEncoding.FLAC;
755+
int sampleRateHertz = 44100;
756+
String languageCode = "en-US";
757+
RecognitionConfig config = RecognitionConfig.newBuilder()
758+
.setEncoding(encoding)
759+
.setSampleRateHertz(sampleRateHertz)
760+
.setLanguageCode(languageCode)
761+
.build();
762+
String uri = "gs://bucket_name/file_name.flac";
763+
RecognitionAudio audio = RecognitionAudio.newBuilder()
764+
.setUri(uri)
765+
.build();
766+
RecognizeResponse response = speechClient.recognize(config, audio);
767+
}
768+
```
769+
770+
Google Cloud Trace (Alpha)
771+
----------------
772+
773+
- [API Documentation][trace-api]
774+
- [Official Documentation][cloud-trace-docs]
775+
776+
### Preview
777+
778+
Here is a code snippet showing a simple usage example of TraceServiceClient. The example assumes that either default application
779+
credentials or a valid api key are available.
780+
Note that you must [supply credentials](#authentication) and a project ID if running this
781+
```java
782+
try (TraceServiceClient traceServiceClient = TraceServiceClient.create()) {
783+
String projectId = "";
784+
Traces traces = Traces.newBuilder().build();
785+
traceServiceClient.patchTraces(projectId, traces);
786+
}
787+
```
788+
789+
Google Cloud Vision (Alpha)
790+
----------------
791+
792+
- [API Documentation][vision-api]
793+
- [Official Documentation][cloud-vision-docs]
794+
795+
### Preview
796+
797+
Here is a code snippet showing a simple usage example of ImageAnnotatorClient.
798+
The example assumes that either default application credentials or a valid api key
799+
are available. (See [Authentication section](#authentication) for more information)
800+
```java
801+
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
802+
List<AnnotateImageRequest> requests = new ArrayList<>();
803+
BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
804+
}
805+
```
806+
686807
Troubleshooting
687808
---------------
688809
@@ -692,6 +813,7 @@ Java Versions
692813
-------------
693814
694815
Java 7 or above is required for using this client.
816+
> Note: GAE standard for Java 7 is not supported for gRPC-based clients.
695817
696818
Android
697819
-------
@@ -749,6 +871,24 @@ Apache 2.0 - See [LICENSE] for more information.
749871
[cloud-dns-docs]: https://cloud.google.com/dns/docs
750872
[cloud-dns-activation]: https://console.cloud.google.com/start/api?id=dns
751873
874+
[errorreporting-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/errorreporting/spi/v1beta1/package-summary.html
875+
[cloud-errorreporting-docs]: https://cloud.google.com/error-reporting/docs
876+
877+
[language-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/language/spi/v1/package-summary.html
878+
[cloud-language-docs]: https://cloud.google.com/language/docs
879+
880+
[monitoring-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/monitoring/spi/v3/package-summary.html
881+
[cloud-monitoring-docs]: https://cloud.google.com/monitoring/docs
882+
883+
[speech-api]: http://googlecloudplatform.github.io/google-cloud-java/0.15.0/apidocs/?com/google/cloud/speech/spi/v1/package-summary.html
884+
[cloud-speech-docs]: https://cloud.google.com/speech/docs
885+
886+
[trace-api]: http://googlecloudplatform.github.io/google-cloud-java/0.15.0/apidocs/?com/google/cloud/trace/spi/v1/package-summary.html
887+
[cloud-trace-docs]: https://cloud.google.com/trace/docs
888+
889+
[vision-api]: http://googlecloudplatform.github.io/google-cloud-java/0.15.0/apidocs/?com/google/cloud/vision/spi/v1/package-summary.html
890+
[cloud-vision-docs]: https://cloud.google.com/vision/docs
891+
752892
[logging-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/logging/package-summary.html
753893
[stackdriver-logging-docs]: https://cloud.google.com/logging/docs
754894
[stackdriver-logging-activation]: https://console.cloud.google.com/start/api?id=logging

0 commit comments

Comments
 (0)