Skip to content

Commit 9f7344b

Browse files
pongadpongad
authored
document gRPC proxy env var (#2169)
Updates #2161.
1 parent 2f215ba commit 9f7344b

14 files changed

Lines changed: 66 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -834,6 +834,20 @@ Troubleshooting
834834
835835
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
836836
837+
Using a proxy
838+
-----
839+
Clients in this repository use either HTTP or gRPC for the transport layer.
840+
The README of each client documents the transport layer the client uses.
841+
842+
For HTTP clients, a proxy can be configured by using `http.proxyHost` and
843+
related system properties as documented by
844+
[Java Networking and Proxies](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html).
845+
846+
For gRPC clients, a proxy can be configured by using the
847+
`GRPC_PROXY_EXP` environment variable as documented by
848+
the gRPC [release notes](https://github.com/grpc/grpc-java/releases/tag/v1.0.3).
849+
Please note that gRPC proxy support is currently experimental.
850+
837851
Java Versions
838852
-------------
839853

‎google-cloud-bigquery/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,10 @@ Troubleshooting
214214

215215
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
216216

217+
Transport
218+
---------
219+
BigQuery uses HTTP for the transport layer.
220+
217221
Java Versions
218222
-------------
219223

‎google-cloud-compute/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -218,6 +218,10 @@ Troubleshooting
218218

219219
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
220220

221+
Transport
222+
---------
223+
Compute uses HTTP for the transport layer.
224+
221225
Java Versions
222226
-------------
223227

‎google-cloud-datastore/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,10 @@ Troubleshooting
150150

151151
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
152152

153+
Transport
154+
---------
155+
Datastore uses HTTP for the transport layer.
156+
153157
Java Versions
154158
-------------
155159

‎google-cloud-dns/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,10 @@ Troubleshooting
342342

343343
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
344344

345+
Transport
346+
---------
347+
DNS uses HTTP for the transport layer.
348+
345349
Java Versions
346350
-------------
347351

‎google-cloud-language/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,10 @@ Troubleshooting
6363

6464
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
6565

66+
Transport
67+
---------
68+
Language uses gRPC for the transport layer.
69+
6670
Java Versions
6771
-------------
6872

‎google-cloud-logging/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,10 @@ and
164164
we put together all the code shown above into three programs. The programs assume that you are
165165
running on Compute Engine or from your own desktop.
166166

167+
Transport
168+
---------
169+
Logging uses gRPC for the transport layer.
170+
167171
Java Versions
168172
-------------
169173

‎google-cloud-pubsub/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,10 @@ and
201201
we put together all the code shown above into two programs. The programs assume that you are
202202
running on Compute Engine, App Engine Flexible or from your own desktop.
203203

204+
Transport
205+
---------
206+
Pub/Sub uses gRPC for the transport layer.
207+
204208
Java Versions
205209
-------------
206210

‎google-cloud-resourcemanager/README.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,10 @@ The third program modifies the IAM policy associated with a project using the re
212212
pattern. Complete source code can be found at
213213
[ModifyPolicy.java](../google-cloud-examples/src/main/java/com/google/cloud/examples/resourcemanager/snippets/ModifyPolicy.java)
214214

215+
Transport
216+
---------
217+
Resource Manager uses HTTP for the transport layer.
218+
215219
Java Versions
216220
-------------
217221

@@ -252,4 +256,3 @@ Apache 2.0 - See [LICENSE] for more information.
252256
[cloud-platform]: https://cloud.google.com/
253257
[cloud-resourcemanager]: https://cloud.google.com/resource-manager/docs
254258
[resourcemanager-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/resourcemanager/package-summary.html
255-

‎google-cloud-spanner/README.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,10 @@ started](https://cloud.google.com/spanner/docs/getting-started/java/) guide.
7070
To get help, follow the instructions in the [shared Troubleshooting
7171
document](https://github.com/GoogleCloudPlatform/gcloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
7272

73+
Transport
74+
---------
75+
Spanner uses gRPC for the transport layer.
76+
7377
## Java Versions
7478

7579
Java 7 or above is required for using this client.

0 commit comments

Comments
 (0)