Skip to content

Commit ae622dd

Browse files
author
Ajay Kannan
committed
---
yaml --- r: 6269 b: refs/heads/tswast-patch-1 c: 68408bf h: refs/heads/master i: 6267: 411ec3c
1 parent 1077faa commit ae622dd

8 files changed

Lines changed: 111 additions & 81 deletions

File tree

‎[refs]‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,5 +57,5 @@ refs/tags/v0.18.0: 9d193c4c4b9d1c6f21515dd8e50836b9194ec9bb
5757
refs/tags/v0.19.0: e67b56e4d8dad5f9a7b38c9b2107c23c828f2ed5
5858
refs/tags/v0.20.0: 839f7fb7156535146aa1cb2c5aadd8d375d854e8
5959
refs/tags/v0.20.1: 370471f437f1f4f68a11e068df5cd6bf39edb1fa
60-
refs/heads/tswast-patch-1: e844c36db4058c1f86dd488af947b58a14ec712c
60+
refs/heads/tswast-patch-1: 68408bf96f704b094f9c709a833e0d99f7afc007
6161
refs/heads/pubsub-streaming-pull: 19262b752ee874eb2ca3b950eb2aef44d5a5267b

‎branches/tswast-patch-1/README.md‎

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,12 @@ Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
99

1010
- [Homepage] (https://googlecloudplatform.github.io/gcloud-java/)
1111
- [API Documentation] (http://googlecloudplatform.github.io/gcloud-java/apidocs)
12-
- [Examples] (http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/gcloud/examples/package-summary.html)
1312

1413
This client supports the following Google Cloud Platform services:
1514

1615
- [Google Cloud Datastore] (#google-cloud-datastore)
1716
- [Google Cloud Storage] (#google-cloud-storage)
1817

19-
<!---
20-
- [Google Cloud Storage] (https://cloud.google.com/storage/)
21-
--->
22-
2318
> Note: This client is a work-in-progress, and may occasionally
2419
> make backwards-incompatible changes.
2520
@@ -34,13 +29,23 @@ Add this to your pom.xml file
3429
</dependency>
3530
```
3631

37-
<!---
3832
Example Applications
3933
--------------------
4034

41-
- `java-datastore-sample`_ - A sample using Cloud Datastore
42-
.. _java-datastore-sample: https://github.com/GoogleCloudPlatform/java-datastore-sample
43-
--->
35+
- [`DatastoreExample`](https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/src/main/java/com/google/gcloud/examples/DatastoreExample.java) - A simple command line interface for the Cloud Datastore
36+
- Read more about using this application on the [`gcloud-java-examples` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/gcloud/examples/DatastoreExample.html).
37+
- [`StorageExample`](https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/src/main/java/com/google/gcloud/examples/StorageExample.java) - A simple command line interface providing some of Cloud Storage's functionality
38+
- Read more about using this application on the [`gcloud-java-examples` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/gcloud/examples/StorageExample.html).
39+
40+
Authentication
41+
--------------
42+
43+
There are multiple ways to authenticate to use Google Cloud services.
44+
45+
1. When using `gcloud-java` libraries from within Compute/App Engine, no additional authentication steps are necessary.
46+
2. When using `gcloud-java` libraries elsewhere, there are two options:
47+
* [Generate a JSON service account key](https://cloud.google.com/storage/docs/authentication?hl=en#service_accounts). Supply a path to the downloaded JSON credentials file when building the options supplied to datastore/storage constructor.
48+
* If running locally for development/testing, you can use use [Google Cloud SDK](https://cloud.google.com/sdk/?hl=en). To use the SDK authentication, [download the SDK](https://cloud.google.com/sdk/?hl=en) if you haven't already. Then login using the SDK (`gcloud auth login` in command line), and set your current project using `gcloud config set project PROJECT_ID`.
4449

4550
Google Cloud Datastore
4651
----------------------
@@ -57,6 +62,8 @@ Cloud Datastore for your project.
5762
See the ``gcloud-java`` API [datastore documentation][datastore-api] to learn how to interact
5863
with the Cloud Datastore using this Client Library.
5964

65+
Here is a code snippet showing a simple usage example from within Compute/App Engine. Note that you must [supply credentials](#authentication) if running this snippet elsewhere.
66+
6067
```java
6168
import com.google.gcloud.datastore.Datastore;
6269
import com.google.gcloud.datastore.DatastoreFactory;
@@ -101,6 +108,8 @@ Cloud Storage for your project.
101108
See the ``gcloud-java`` API [storage documentation][storage-api] to learn how to interact
102109
with the Cloud Storage using this Client Library.
103110

111+
Here is a code snippet showing a simple usage example from within Compute/App Engine. Note that you must [supply credentials](#authentication) if running this snippet elsewhere.
112+
104113
```java
105114
import static java.nio.charset.StandardCharsets.UTF_8;
106115

@@ -127,27 +136,18 @@ if (!blob.exists()) {
127136
}
128137
```
129138

139+
Java Versions
140+
-------------
141+
142+
Java 7 or above is required for using this client.
143+
130144
Testing
131145
-------
132146

133147
This library provides tools to help write tests for code that uses gcloud-java services.
134148

135149
See [TESTING] to read more about using our testing helpers.
136150

137-
Contributing
138-
------------
139-
140-
Contributions to this library are always welcome and highly encouraged.
141-
142-
See [CONTRIBUTING] for more information on how to get started.
143-
144-
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.
145-
146-
Java Versions
147-
-------------
148-
149-
Java 7 or above is required for using this client.
150-
151151
Versioning
152152
----------
153153

@@ -157,6 +157,15 @@ It is currently in major version zero (``0.y.z``), which means that anything
157157
may change at any time and the public API should not be considered
158158
stable.
159159

160+
Contributing
161+
------------
162+
163+
Contributions to this library are always welcome and highly encouraged.
164+
165+
See [CONTRIBUTING] for more information on how to get started.
166+
167+
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.
168+
160169
License
161170
-------
162171

‎branches/tswast-patch-1/gcloud-java-core/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ This module provides common functionality required by service-specific modules o
55

66
[![Build Status](https://travis-ci.org/GoogleCloudPlatform/gcloud-java.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/gcloud-java)
77
[![Coverage Status](https://coveralls.io/repos/GoogleCloudPlatform/gcloud-java/badge.svg?branch=master)](https://coveralls.io/r/GoogleCloudPlatform/gcloud-java?branch=master)
8+
[![Maven](https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-core.svg)](https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-core.svg)
89

910
- [Homepage] (https://googlecloudplatform.github.io/gcloud-java/)
1011
- [API Documentation] (http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/gcloud/package-summary.html)
11-
- [Examples] (http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/gcloud/examples/package-summary.html)
1212

1313
Quickstart
1414
----------
@@ -21,18 +21,18 @@ Add this to your pom.xml file
2121
</dependency>
2222
```
2323

24+
Java Versions
25+
-------------
26+
27+
Java 7 or above is required for using this client.
28+
2429
Contributing
2530
------------
2631

2732
Contributions to this library are always welcome and highly encouraged.
2833

2934
See [CONTRIBUTING] for more information on how to get started.
3035

31-
Java Versions
32-
-------------
33-
34-
Java 7 or above is required for using this client.
35-
3636
Versioning
3737
----------
3838

‎branches/tswast-patch-1/gcloud-java-core/src/main/java/com/google/gcloud/RetryParams.java‎

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ public final class RetryParams implements Serializable {
6666
private static final RetryParams NO_RETRIES =
6767
builder().retryMaxAttempts(1).retryMinAttempts(1).build();
6868

69+
6970
/**
7071
* RetryParams builder.
7172
*/
@@ -205,53 +206,47 @@ public static RetryParams getDefaultInstance() {
205206
return DEFAULT_INSTANCE;
206207
}
207208

208-
/**
209-
* Returns an instance of {@code RetryParams} where `retryMaxAttempts` and `retryMinAttempts` are
210-
* set to `1`.
211-
*/
212209
public static RetryParams noRetries() {
213210
return NO_RETRIES;
214211
}
215212

216213
/**
217-
* Returns the retryMinAttempts. Default value is {@value #DEFAULT_RETRY_MIN_ATTEMPTS}.
214+
* Returns the retryMinAttempts.
218215
*/
219216
public int getRetryMinAttempts() {
220217
return retryMinAttempts;
221218
}
222219

223220
/**
224-
* Returns the retryMaxAttempts. Default value is {@value #DEFAULT_RETRY_MAX_ATTEMPTS}.
221+
* Returns the retryMaxAttempts.
225222
*/
226223
public int getRetryMaxAttempts() {
227224
return retryMaxAttempts;
228225
}
229226

230227
/**
231-
* Returns the initialRetryDelayMillis. Default value is
232-
* {@value #DEFAULT_INITIAL_RETRY_DELAY_MILLIS}.
228+
* Returns the initialRetryDelayMillis.
233229
*/
234230
public long getInitialRetryDelayMillis() {
235231
return initialRetryDelayMillis;
236232
}
237233

238234
/**
239-
* Returns the maxRetryDelayMillis. Default values is {@value #DEFAULT_MAX_RETRY_DELAY_MILLIS}.
235+
* Returns the maxRetryDelayMillis.
240236
*/
241237
public long getMaxRetryDelayMillis() {
242238
return maxRetryDelayMillis;
243239
}
244240

245241
/**
246-
* Returns the maxRetryDelayBackoffFactor. Default values is
247-
* {@value #DEFAULT_RETRY_DELAY_BACKOFF_FACTOR}.
242+
* Returns the maxRetryDelayBackoffFactor.
248243
*/
249244
public double getRetryDelayBackoffFactor() {
250245
return retryDelayBackoffFactor;
251246
}
252247

253248
/**
254-
* Returns the totalRetryPeriodMillis. Default value is {@value #DEFAULT_TOTAL_RETRY_PERIOD_MILLIS}.
249+
* Returns the totalRetryPeriodMillis.
255250
*/
256251
public long getTotalRetryPeriodMillis() {
257252
return totalRetryPeriodMillis;

‎branches/tswast-patch-1/gcloud-java-core/src/main/java/com/google/gcloud/ServiceOptions.java‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616

1717
package com.google.gcloud;
1818

19+
1920
import static com.google.common.base.MoreObjects.firstNonNull;
2021
import static com.google.common.base.Preconditions.checkNotNull;
2122
import static java.nio.charset.StandardCharsets.UTF_8;
@@ -166,8 +167,7 @@ public B authCredentials(AuthCredentials authCredentials) {
166167
}
167168

168169
/**
169-
* Sets configuration parameters for request retries. If no configuration is set
170-
* {@link RetryParams#noRetries()} is used.
170+
* Sets configuration parameters for request retries.
171171
*
172172
* @return the builder.
173173
*/
@@ -367,8 +367,7 @@ public AuthCredentials authCredentials() {
367367
}
368368

369369
/**
370-
* Returns configuration parameters for request retries. By default requests are not retried:
371-
* {@link RetryParams#noRetries()} is used.
370+
* Returns configuration parameters for request retries.
372371
*/
373372
public RetryParams retryParams() {
374373
return retryParams != null ? retryParams : RetryParams.noRetries();

‎branches/tswast-patch-1/gcloud-java-datastore/README.md‎

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ Java idiomatic client for [Google Cloud Datastore] (https://cloud.google.com/dat
55

66
[![Build Status](https://travis-ci.org/GoogleCloudPlatform/gcloud-java.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/gcloud-java)
77
[![Coverage Status](https://coveralls.io/repos/GoogleCloudPlatform/gcloud-java/badge.svg?branch=master)](https://coveralls.io/r/GoogleCloudPlatform/gcloud-java?branch=master)
8+
[![Maven](https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-datastore.svg)]( https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-datastore.svg)
89

910
- [Homepage] (https://googlecloudplatform.github.io/gcloud-java/)
1011
- [API Documentation] (http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/gcloud/datastore/package-summary.html)
11-
- [Examples] (http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/gcloud/examples/DatastoreExample.html)
1212

1313
> Note: This client is a work-in-progress, and may occasionally
1414
> make backwards-incompatible changes.
@@ -24,6 +24,18 @@ Add this to your pom.xml file
2424
</dependency>
2525
```
2626

27+
Example Application
28+
--------------------
29+
[`DatastoreExample`](https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/gcloud-java-examples/src/main/java/com/google/gcloud/examples/DatastoreExample.java) is a simple command line interface for the Cloud Datastore. Read more about using the application on the [`gcloud-java-examples` docs page](http://googlecloudplatform.github.io/gcloud-java/apidocs/?com/google/gcloud/examples/DatastoreExample.html).
30+
31+
Authentication
32+
--------------
33+
34+
See the [Authentication](https://github.com/GoogleCloudPlatform/gcloud-java#authentication) section in the main repository's README.
35+
36+
About Google Cloud Datastore
37+
----------------------------
38+
2739
Google [Cloud Datastore][cloud-datastore] is a fully managed, schemaless database for
2840
storing non-relational data. Cloud Datastore automatically scales with
2941
your users and supports ACID transactions, high availability of reads and
@@ -36,6 +48,8 @@ Cloud Datastore for your project.
3648
See the ``gcloud-java`` API [datastore documentation][datastore-api] to learn how to interact
3749
with the Cloud Datastore using this Client Library.
3850

51+
Here is a code snippet showing a simple usage example from within Compute/App Engine. Note that you must [supply credentials](https://github.com/GoogleCloudPlatform/gcloud-java#authentication) if running this snippet elsewhere.
52+
3953
```java
4054
import com.google.gcloud.datastore.Datastore;
4155
import com.google.gcloud.datastore.DatastoreFactory;
@@ -66,25 +80,18 @@ if (entity == null) {
6680
}
6781
```
6882

83+
Java Versions
84+
-------------
85+
86+
Java 7 or above is required for using this client.
87+
6988
Testing
7089
-------
7190

7291
This library has tools to help write tests for code that uses the Datastore.
7392

7493
See [TESTING] to read more about testing.
7594

76-
Contributing
77-
------------
78-
79-
Contributions to this library are always welcome and highly encouraged.
80-
81-
See [CONTRIBUTING] for more information on how to get started.
82-
83-
Java Versions
84-
-------------
85-
86-
Java 7 or above is required for using this client.
87-
8895
Versioning
8996
----------
9097

@@ -94,6 +101,13 @@ It is currently in major version zero (``0.y.z``), which means that anything
94101
may change at any time and the public API should not be considered
95102
stable.
96103

104+
Contributing
105+
------------
106+
107+
Contributions to this library are always welcome and highly encouraged.
108+
109+
See [CONTRIBUTING] for more information on how to get started.
110+
97111
License
98112
-------
99113

‎branches/tswast-patch-1/gcloud-java-examples/README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Examples for gcloud-java (Java idiomatic client for [Google Cloud Platform][clou
55

66
[![Build Status](https://travis-ci.org/GoogleCloudPlatform/gcloud-java.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/gcloud-java)
77
[![Coverage Status](https://coveralls.io/repos/GoogleCloudPlatform/gcloud-java/badge.svg?branch=master)](https://coveralls.io/r/GoogleCloudPlatform/gcloud-java?branch=master)
8+
[![Maven](https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-examples.svg)]( https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-examples.svg)
89

910
- [Homepage] (https://googlecloudplatform.github.io/gcloud-java/)
1011
- [Examples] (http://googlecloudplatform.github.io/gcloud-java/apidocs/index.html?com/google/gcloud/examples/package-summary.html)
@@ -49,13 +50,6 @@ To run examples from your command line:
4950
$mvn exec:java -Dexec.mainClass="com.google.gcloud.examples.StorageExample" -Dexec.args="delete <bucket_name> test.txt"
5051
```
5152

52-
Contributing
53-
------------
54-
55-
Contributions to this library are always welcome and highly encouraged.
56-
57-
See [CONTRIBUTING] for more information on how to get started.
58-
5953
Java Versions
6054
-------------
6155

@@ -70,6 +64,13 @@ It is currently in major version zero (``0.y.z``), which means that anything
7064
may change at any time and the public API should not be considered
7165
stable.
7266

67+
Contributing
68+
------------
69+
70+
Contributions to this library are always welcome and highly encouraged.
71+
72+
See [CONTRIBUTING] for more information on how to get started.
73+
7374
License
7475
-------
7576

0 commit comments

Comments
 (0)