Skip to content

Commit 591dbb3

Browse files
authored
README Update (declaring GA) [ci skip] (#2007)
* README update/fix Logging, Storage and Datastore are defined GA Vision and Language are moved to Beta from Alpha
1 parent 045b923 commit 591dbb3

1 file changed

Lines changed: 94 additions & 87 deletions

File tree

README.md

Lines changed: 94 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -12,27 +12,29 @@ Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
1212
- [Homepage](https://googlecloudplatform.github.io/google-cloud-java/)
1313
- [API Documentation](https://googlecloudplatform.github.io/google-cloud-java/apidocs)
1414

15+
This client supports the following Google Cloud Platform services at a [GA](#versioning) quality level:
16+
- [Stackdriver Logging](#stackdriver-logging-ga) (GA)
17+
- [Cloud Datastore](#google-cloud-datastore-ga) (GA)
18+
- [Cloud Storage](#google-cloud-storage-ga) (GA)
19+
1520
This client supports the following Google Cloud Platform services at a [Beta](#versioning) quality level:
1621

1722
- [BigQuery](#google-cloud-bigquery-beta) (Beta)
18-
- [Stackdriver Logging](#stackdriver-logging-beta) (Beta - Not working on App Engine Standard)
19-
- [Cloud Datastore](#google-cloud-datastore-beta) (Beta)
20-
- [Cloud Storage](#google-cloud-storage-beta) (Beta)
2123
- [Cloud Spanner](#cloud-spanner-beta) (Beta)
2224
- [Cloud Translation](#google-translation-beta) (Beta)
25+
- [Cloud Natural Language](#google-cloud-language-beta) (Beta)
26+
- [Cloud Vision](#google-cloud-vision-beta) (Beta)
2327

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

2630
- [Cloud Compute](#google-cloud-compute-alpha) (Alpha)
2731
- [Cloud DNS](#google-cloud-dns-alpha) (Alpha)
2832
- [Stackdriver Error Reporting](#stackdriver-error-reporting-alpha) (Alpha)
2933
- [Stackdriver Monitoring](#stackdriver-monitoring-alpha) (Alpha)
30-
- [Cloud Natural Language](#google-cloud-language-alpha) (Alpha)
31-
- [Cloud Pub/Sub](#google-cloud-pubsub-alpha) (Alpha - Not working on App Engine Standard)
34+
- [Cloud Pub/Sub](#google-cloud-pubsub-alpha) (Alpha)
3235
- [Cloud Resource Manager](#google-cloud-resource-manager-alpha) (Alpha)
3336
- [Cloud Speech](#google-cloud-speech-alpha) (Alpha)
3437
- [Cloud Trace](#google-cloud-trace-alpha) (Alpha)
35-
- [Cloud Vision](#google-cloud-vision-alpha) (Alpha)
3638

3739
> Note: This client is a work-in-progress, and may occasionally
3840
> make backwards-incompatible changes.
@@ -183,51 +185,7 @@ Credentials in the following locations (in order):
183185
4. Google Cloud Shell built-in credentials
184186
5. Google Compute Engine built-in credentials
185187
186-
Google Cloud BigQuery (Beta)
187-
----------------------
188-
189-
- [API Documentation][bigquery-api]
190-
- [Official Documentation][cloud-bigquery-docs]
191-
192-
#### Preview
193-
194-
Here is a code snippet showing a simple usage example from within Compute/App Engine. Note that you
195-
must [supply credentials](#authentication) and a project ID if running this snippet elsewhere.
196-
Complete source code can be found at
197-
[CreateTableAndLoadData.java](./google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/CreateTableAndLoadData.java).
198-
199-
```java
200-
import com.google.cloud.bigquery.BigQuery;
201-
import com.google.cloud.bigquery.BigQueryOptions;
202-
import com.google.cloud.bigquery.Field;
203-
import com.google.cloud.bigquery.FormatOptions;
204-
import com.google.cloud.bigquery.Job;
205-
import com.google.cloud.bigquery.Schema;
206-
import com.google.cloud.bigquery.StandardTableDefinition;
207-
import com.google.cloud.bigquery.Table;
208-
import com.google.cloud.bigquery.TableId;
209-
import com.google.cloud.bigquery.TableInfo;
210-
211-
BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
212-
TableId tableId = TableId.of("dataset", "table");
213-
Table table = bigquery.getTable(tableId);
214-
if (table == null) {
215-
System.out.println("Creating table " + tableId);
216-
Field integerField = Field.of("fieldName", Field.Type.integer());
217-
Schema schema = Schema.of(integerField);
218-
table = bigquery.create(TableInfo.of(tableId, StandardTableDefinition.of(schema)));
219-
}
220-
System.out.println("Loading data into table " + tableId);
221-
Job loadJob = table.load(FormatOptions.csv(), "gs://bucket/path");
222-
loadJob = loadJob.waitFor();
223-
if (loadJob.getStatus().getError() != null) {
224-
System.out.println("Job completed with errors");
225-
} else {
226-
System.out.println("Job succeeded");
227-
}
228-
```
229-
230-
Stackdriver Logging (Beta)
188+
Stackdriver Logging (GA)
231189
----------------------
232190
- [API Documentation][logging-api]
233191
- [Official Documentation][stackdriver-logging-docs]
@@ -296,7 +254,7 @@ LoggingHandler.addHandler(logger, new LoggingHandler());
296254
logger.warning("test warning");
297255
```
298256
299-
Google Cloud Datastore (Beta)
257+
Google Cloud Datastore (GA)
300258
----------------------
301259
302260
- [API Documentation][datastore-api]
@@ -353,7 +311,7 @@ if (entity != null) {
353311
}
354312
```
355313
356-
Google Cloud Storage (Beta)
314+
Google Cloud Storage (GA)
357315
----------------------
358316
359317
- [API Documentation][storage-api]
@@ -407,6 +365,51 @@ if (blob != null) {
407365
channel.close();
408366
}
409367
```
368+
369+
Google Cloud BigQuery (Beta)
370+
----------------------
371+
372+
- [API Documentation][bigquery-api]
373+
- [Official Documentation][cloud-bigquery-docs]
374+
375+
#### Preview
376+
377+
Here is a code snippet showing a simple usage example from within Compute/App Engine. Note that you
378+
must [supply credentials](#authentication) and a project ID if running this snippet elsewhere.
379+
Complete source code can be found at
380+
[CreateTableAndLoadData.java](./google-cloud-examples/src/main/java/com/google/cloud/examples/bigquery/snippets/CreateTableAndLoadData.java).
381+
382+
```java
383+
import com.google.cloud.bigquery.BigQuery;
384+
import com.google.cloud.bigquery.BigQueryOptions;
385+
import com.google.cloud.bigquery.Field;
386+
import com.google.cloud.bigquery.FormatOptions;
387+
import com.google.cloud.bigquery.Job;
388+
import com.google.cloud.bigquery.Schema;
389+
import com.google.cloud.bigquery.StandardTableDefinition;
390+
import com.google.cloud.bigquery.Table;
391+
import com.google.cloud.bigquery.TableId;
392+
import com.google.cloud.bigquery.TableInfo;
393+
394+
BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
395+
TableId tableId = TableId.of("dataset", "table");
396+
Table table = bigquery.getTable(tableId);
397+
if (table == null) {
398+
System.out.println("Creating table " + tableId);
399+
Field integerField = Field.of("fieldName", Field.Type.integer());
400+
Schema schema = Schema.of(integerField);
401+
table = bigquery.create(TableInfo.of(tableId, StandardTableDefinition.of(schema)));
402+
}
403+
System.out.println("Loading data into table " + tableId);
404+
Job loadJob = table.load(FormatOptions.csv(), "gs://bucket/path");
405+
loadJob = loadJob.waitFor();
406+
if (loadJob.getStatus().getError() != null) {
407+
System.out.println("Job completed with errors");
408+
} else {
409+
System.out.println("Job succeeded");
410+
}
411+
```
412+
410413
Cloud Spanner (Beta)
411414
--------------------
412415
@@ -447,6 +450,40 @@ try {
447450
}
448451
```
449452
453+
Google Cloud Language (Beta)
454+
----------------------
455+
- [API Documentation][language-api]
456+
- [Official Documentation][cloud-language-docs]
457+
458+
### Preview
459+
460+
Here is a code snippet showing a simple usage example of LanguageServiceClient. The example assumes that either default application
461+
credentials or a valid api key are available. (See [Authentication section](#authentication) for more information)
462+
```java
463+
try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
464+
Document document = Document.newBuilder().build();
465+
AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
466+
}
467+
```
468+
469+
Google Cloud Vision (Beta)
470+
----------------
471+
472+
- [API Documentation][vision-api]
473+
- [Official Documentation][cloud-vision-docs]
474+
475+
### Preview
476+
477+
Here is a code snippet showing a simple usage example of ImageAnnotatorClient.
478+
The example assumes that either default application credentials or a valid api key
479+
are available. (See [Authentication section](#authentication) for more information)
480+
```java
481+
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
482+
List<AnnotateImageRequest> requests = new ArrayList<>();
483+
BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
484+
}
485+
```
486+
450487
Google Cloud Compute (Alpha)
451488
----------------------
452489
@@ -593,22 +630,6 @@ Note that you must [supply credentials](#authentication) and a project ID if run
593630
}
594631
```
595632
596-
Google Cloud Language (Alpha)
597-
----------------------
598-
- [API Documentation][language-api]
599-
- [Official Documentation][cloud-language-docs]
600-
601-
### Preview
602-
603-
Here is a code snippet showing a simple usage example of LanguageServiceClient. The example assumes that either default application
604-
credentials or a valid api key are available. (See [Authentication section](#authentication) for more information)
605-
```java
606-
try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
607-
Document document = Document.newBuilder().build();
608-
AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
609-
}
610-
```
611-
612633
Stackdriver Monitoring (Alpha)
613634
----------------------
614635
- [API Documentation][monitoring-api]
@@ -784,24 +805,6 @@ Note that you must [supply credentials](#authentication) and a project ID if run
784805
}
785806
```
786807
787-
Google Cloud Vision (Alpha)
788-
----------------
789-
790-
- [API Documentation][vision-api]
791-
- [Official Documentation][cloud-vision-docs]
792-
793-
### Preview
794-
795-
Here is a code snippet showing a simple usage example of ImageAnnotatorClient.
796-
The example assumes that either default application credentials or a valid api key
797-
are available. (See [Authentication section](#authentication) for more information)
798-
```java
799-
try (ImageAnnotatorClient imageAnnotatorClient = ImageAnnotatorClient.create()) {
800-
List<AnnotateImageRequest> requests = new ArrayList<>();
801-
BatchAnnotateImagesResponse response = imageAnnotatorClient.batchAnnotateImages(requests);
802-
}
803-
```
804-
805808
Troubleshooting
806809
---------------
807810
@@ -853,6 +856,10 @@ additional qualifications:
853856
Please note it is currently under active development. Any release versioned 0.x.y is
854857
subject to backwards incompatible changes at any time.
855858
859+
**GA**: Libraries defined at a GA quality level are expected to be stable and all updates in the
860+
libraries are guaranteed to be backwards-compatible. Any backwards-incompatible changes will lead
861+
to the major version increment (1.x.y -> 2.0.0).
862+
856863
**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and
857864
we're working towards their release candidate. We will address issues and requests with
858865
a higher priority.

0 commit comments

Comments
 (0)