Skip to content

Commit 68d152f

Browse files
feat: Enable REST transport for most of Java and Go clients (#734)
- [ ] Regenerate this pull request now. PiperOrigin-RevId: 456641589 Source-Link: googleapis/googleapis@8a251f5 Source-Link: https://github.com/googleapis/googleapis-gen/commit/4ca52a529cf01308d9714950edffbea3560cfbdb Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNGNhNTJhNTI5Y2YwMTMwOGQ5NzE0OTUwZWRmZmJlYTM1NjBjZmJkYiJ9
1 parent 4b3fba5 commit 68d152f

File tree

91 files changed

+7136
-7
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+7136
-7
lines changed

java-iot/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ implementation 'com.google.cloud:google-cloud-iot'
5656
If you are using Gradle without BOM, add this to your dependencies
5757

5858
```Groovy
59-
implementation 'com.google.cloud:google-cloud-iot:2.2.0'
59+
implementation 'com.google.cloud:google-cloud-iot:2.2.1'
6060
```
6161

6262
If you are using SBT, add this to your dependencies
6363

6464
```Scala
65-
libraryDependencies += "com.google.cloud" % "google-cloud-iot" % "2.2.0"
65+
libraryDependencies += "com.google.cloud" % "google-cloud-iot" % "2.2.1"
6666
```
6767

6868
## Authentication

java-iot/google-cloud-iot/pom.xml

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,10 @@
6262
<groupId>com.google.api</groupId>
6363
<artifactId>gax-grpc</artifactId>
6464
</dependency>
65+
<dependency>
66+
<groupId>com.google.api</groupId>
67+
<artifactId>gax-httpjson</artifactId>
68+
</dependency>
6569
<dependency>
6670
<groupId>org.threeten</groupId>
6771
<artifactId>threetenbp</artifactId>
@@ -85,12 +89,24 @@
8589
<scope>test</scope>
8690
</dependency>
8791
<!-- Need testing utility classes for generated gRPC clients tests -->
92+
<dependency>
93+
<groupId>com.google.api</groupId>
94+
<artifactId>gax</artifactId>
95+
<classifier>testlib</classifier>
96+
<scope>test</scope>
97+
</dependency>
8898
<dependency>
8999
<groupId>com.google.api</groupId>
90100
<artifactId>gax-grpc</artifactId>
91101
<classifier>testlib</classifier>
92102
<scope>test</scope>
93103
</dependency>
104+
<dependency>
105+
<groupId>com.google.api</groupId>
106+
<artifactId>gax-httpjson</artifactId>
107+
<classifier>testlib</classifier>
108+
<scope>test</scope>
109+
</dependency>
94110
</dependencies>
95111

96112
<profiles>

java-iot/google-cloud-iot/src/main/java/com/google/cloud/iot/v1/DeviceManagerClient.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,20 @@
106106
* DeviceManagerClient deviceManagerClient = DeviceManagerClient.create(deviceManagerSettings);
107107
* }</pre>
108108
*
109+
* <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
110+
* the wire:
111+
*
112+
* <pre>{@code
113+
* // This snippet has been automatically generated for illustrative purposes only.
114+
* // It may require modifications to work in your environment.
115+
* DeviceManagerSettings deviceManagerSettings =
116+
* DeviceManagerSettings.newBuilder()
117+
* .setTransportChannelProvider(
118+
* DeviceManagerSettings.defaultHttpJsonTransportProviderBuilder().build())
119+
* .build();
120+
* DeviceManagerClient deviceManagerClient = DeviceManagerClient.create(deviceManagerSettings);
121+
* }</pre>
122+
*
109123
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
110124
*/
111125
@Generated("by gapic-generator-java")

java-iot/google-cloud-iot/src/main/java/com/google/cloud/iot/v1/DeviceManagerSettings.java

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import com.google.api.gax.core.GoogleCredentialsProvider;
2525
import com.google.api.gax.core.InstantiatingExecutorProvider;
2626
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
27+
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
2728
import com.google.api.gax.rpc.ApiClientHeaderProvider;
2829
import com.google.api.gax.rpc.ClientContext;
2930
import com.google.api.gax.rpc.ClientSettings;
@@ -211,11 +212,18 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
211212
return DeviceManagerStubSettings.defaultCredentialsProviderBuilder();
212213
}
213214

214-
/** Returns a builder for the default ChannelProvider for this service. */
215+
/** Returns a builder for the default gRPC ChannelProvider for this service. */
215216
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
216217
return DeviceManagerStubSettings.defaultGrpcTransportProviderBuilder();
217218
}
218219

220+
/** Returns a builder for the default REST ChannelProvider for this service. */
221+
@BetaApi
222+
public static InstantiatingHttpJsonChannelProvider.Builder
223+
defaultHttpJsonTransportProviderBuilder() {
224+
return DeviceManagerStubSettings.defaultHttpJsonTransportProviderBuilder();
225+
}
226+
219227
public static TransportChannelProvider defaultTransportChannelProvider() {
220228
return DeviceManagerStubSettings.defaultTransportChannelProvider();
221229
}
@@ -225,11 +233,17 @@ public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuil
225233
return DeviceManagerStubSettings.defaultApiClientHeaderProviderBuilder();
226234
}
227235

228-
/** Returns a new builder for this class. */
236+
/** Returns a new gRPC builder for this class. */
229237
public static Builder newBuilder() {
230238
return Builder.createDefault();
231239
}
232240

241+
/** Returns a new REST builder for this class. */
242+
@BetaApi
243+
public static Builder newHttpJsonBuilder() {
244+
return Builder.createHttpJsonDefault();
245+
}
246+
233247
/** Returns a new builder for this class. */
234248
public static Builder newBuilder(ClientContext clientContext) {
235249
return new Builder(clientContext);
@@ -267,6 +281,11 @@ private static Builder createDefault() {
267281
return new Builder(DeviceManagerStubSettings.newBuilder());
268282
}
269283

284+
@BetaApi
285+
private static Builder createHttpJsonDefault() {
286+
return new Builder(DeviceManagerStubSettings.newHttpJsonBuilder());
287+
}
288+
270289
public DeviceManagerStubSettings.Builder getStubSettingsBuilder() {
271290
return ((DeviceManagerStubSettings.Builder) getStubSettings());
272291
}

java-iot/google-cloud-iot/src/main/java/com/google/cloud/iot/v1/stub/DeviceManagerStubSettings.java

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@
2828
import com.google.api.gax.grpc.GaxGrpcProperties;
2929
import com.google.api.gax.grpc.GrpcTransportChannel;
3030
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
31+
import com.google.api.gax.httpjson.GaxHttpJsonProperties;
32+
import com.google.api.gax.httpjson.HttpJsonTransportChannel;
33+
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
3134
import com.google.api.gax.retrying.RetrySettings;
3235
import com.google.api.gax.rpc.ApiCallContext;
3336
import com.google.api.gax.rpc.ApiClientHeaderProvider;
@@ -391,6 +394,11 @@ public DeviceManagerStub createStub() throws IOException {
391394
.equals(GrpcTransportChannel.getGrpcTransportName())) {
392395
return GrpcDeviceManagerStub.create(this);
393396
}
397+
if (getTransportChannelProvider()
398+
.getTransportName()
399+
.equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
400+
return HttpJsonDeviceManagerStub.create(this);
401+
}
394402
throw new UnsupportedOperationException(
395403
String.format(
396404
"Transport not supported: %s", getTransportChannelProvider().getTransportName()));
@@ -423,30 +431,56 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
423431
.setUseJwtAccessWithScope(true);
424432
}
425433

426-
/** Returns a builder for the default ChannelProvider for this service. */
434+
/** Returns a builder for the default gRPC ChannelProvider for this service. */
427435
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
428436
return InstantiatingGrpcChannelProvider.newBuilder()
429437
.setMaxInboundMessageSize(Integer.MAX_VALUE);
430438
}
431439

440+
/** Returns a builder for the default REST ChannelProvider for this service. */
441+
@BetaApi
442+
public static InstantiatingHttpJsonChannelProvider.Builder
443+
defaultHttpJsonTransportProviderBuilder() {
444+
return InstantiatingHttpJsonChannelProvider.newBuilder();
445+
}
446+
432447
public static TransportChannelProvider defaultTransportChannelProvider() {
433448
return defaultGrpcTransportProviderBuilder().build();
434449
}
435450

436451
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
437-
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
452+
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
438453
return ApiClientHeaderProvider.newBuilder()
439454
.setGeneratedLibToken(
440455
"gapic", GaxProperties.getLibraryVersion(DeviceManagerStubSettings.class))
441456
.setTransportToken(
442457
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
443458
}
444459

445-
/** Returns a new builder for this class. */
460+
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
461+
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
462+
return ApiClientHeaderProvider.newBuilder()
463+
.setGeneratedLibToken(
464+
"gapic", GaxProperties.getLibraryVersion(DeviceManagerStubSettings.class))
465+
.setTransportToken(
466+
GaxHttpJsonProperties.getHttpJsonTokenName(),
467+
GaxHttpJsonProperties.getHttpJsonVersion());
468+
}
469+
470+
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
471+
return DeviceManagerStubSettings.defaultGrpcApiClientHeaderProviderBuilder();
472+
}
473+
474+
/** Returns a new gRPC builder for this class. */
446475
public static Builder newBuilder() {
447476
return Builder.createDefault();
448477
}
449478

479+
/** Returns a new REST builder for this class. */
480+
public static Builder newHttpJsonBuilder() {
481+
return Builder.createHttpJsonDefault();
482+
}
483+
450484
/** Returns a new builder for this class. */
451485
public static Builder newBuilder(ClientContext clientContext) {
452486
return new Builder(clientContext);
@@ -694,6 +728,19 @@ private static Builder createDefault() {
694728
return initDefaults(builder);
695729
}
696730

731+
private static Builder createHttpJsonDefault() {
732+
Builder builder = new Builder(((ClientContext) null));
733+
734+
builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
735+
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
736+
builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
737+
builder.setEndpoint(getDefaultEndpoint());
738+
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
739+
builder.setSwitchToMtlsEndpointAllowed(true);
740+
741+
return initDefaults(builder);
742+
}
743+
697744
private static Builder initDefaults(Builder builder) {
698745
builder
699746
.createDeviceRegistrySettings()
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
/*
2+
* Copyright 2022 Google LLC
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.cloud.iot.v1.stub;
18+
19+
import com.google.api.core.BetaApi;
20+
import com.google.api.gax.httpjson.HttpJsonCallSettings;
21+
import com.google.api.gax.httpjson.HttpJsonCallableFactory;
22+
import com.google.api.gax.httpjson.HttpJsonOperationSnapshotCallable;
23+
import com.google.api.gax.httpjson.HttpJsonStubCallableFactory;
24+
import com.google.api.gax.httpjson.longrunning.stub.OperationsStub;
25+
import com.google.api.gax.rpc.BatchingCallSettings;
26+
import com.google.api.gax.rpc.ClientContext;
27+
import com.google.api.gax.rpc.OperationCallSettings;
28+
import com.google.api.gax.rpc.OperationCallable;
29+
import com.google.api.gax.rpc.PagedCallSettings;
30+
import com.google.api.gax.rpc.ServerStreamingCallSettings;
31+
import com.google.api.gax.rpc.ServerStreamingCallable;
32+
import com.google.api.gax.rpc.UnaryCallSettings;
33+
import com.google.api.gax.rpc.UnaryCallable;
34+
import com.google.longrunning.Operation;
35+
import javax.annotation.Generated;
36+
37+
// AUTO-GENERATED DOCUMENTATION AND CLASS.
38+
/**
39+
* REST callable factory implementation for the DeviceManager service API.
40+
*
41+
* <p>This class is for advanced usage.
42+
*/
43+
@Generated("by gapic-generator-java")
44+
@BetaApi
45+
public class HttpJsonDeviceManagerCallableFactory
46+
implements HttpJsonStubCallableFactory<Operation, OperationsStub> {
47+
48+
@Override
49+
public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCallable(
50+
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
51+
UnaryCallSettings<RequestT, ResponseT> callSettings,
52+
ClientContext clientContext) {
53+
return HttpJsonCallableFactory.createUnaryCallable(
54+
httpJsonCallSettings, callSettings, clientContext);
55+
}
56+
57+
@Override
58+
public <RequestT, ResponseT, PagedListResponseT>
59+
UnaryCallable<RequestT, PagedListResponseT> createPagedCallable(
60+
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
61+
PagedCallSettings<RequestT, ResponseT, PagedListResponseT> callSettings,
62+
ClientContext clientContext) {
63+
return HttpJsonCallableFactory.createPagedCallable(
64+
httpJsonCallSettings, callSettings, clientContext);
65+
}
66+
67+
@Override
68+
public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createBatchingCallable(
69+
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
70+
BatchingCallSettings<RequestT, ResponseT> callSettings,
71+
ClientContext clientContext) {
72+
return HttpJsonCallableFactory.createBatchingCallable(
73+
httpJsonCallSettings, callSettings, clientContext);
74+
}
75+
76+
@BetaApi(
77+
"The surface for long-running operations is not stable yet and may change in the future.")
78+
@Override
79+
public <RequestT, ResponseT, MetadataT>
80+
OperationCallable<RequestT, ResponseT, MetadataT> createOperationCallable(
81+
HttpJsonCallSettings<RequestT, Operation> httpJsonCallSettings,
82+
OperationCallSettings<RequestT, ResponseT, MetadataT> callSettings,
83+
ClientContext clientContext,
84+
OperationsStub operationsStub) {
85+
UnaryCallable<RequestT, Operation> innerCallable =
86+
HttpJsonCallableFactory.createBaseUnaryCallable(
87+
httpJsonCallSettings, callSettings.getInitialCallSettings(), clientContext);
88+
HttpJsonOperationSnapshotCallable<RequestT, Operation> initialCallable =
89+
new HttpJsonOperationSnapshotCallable<RequestT, Operation>(
90+
innerCallable,
91+
httpJsonCallSettings.getMethodDescriptor().getOperationSnapshotFactory());
92+
return HttpJsonCallableFactory.createOperationCallable(
93+
callSettings, clientContext, operationsStub.longRunningClient(), initialCallable);
94+
}
95+
96+
@Override
97+
public <RequestT, ResponseT>
98+
ServerStreamingCallable<RequestT, ResponseT> createServerStreamingCallable(
99+
HttpJsonCallSettings<RequestT, ResponseT> httpJsonCallSettings,
100+
ServerStreamingCallSettings<RequestT, ResponseT> callSettings,
101+
ClientContext clientContext) {
102+
return HttpJsonCallableFactory.createServerStreamingCallable(
103+
httpJsonCallSettings, callSettings, clientContext);
104+
}
105+
}

0 commit comments

Comments
 (0)