Skip to content

Commit 5bd7ad6

Browse files
feat: Enable REST transport for most of Java and Go clients (googleapis#106)
- [ ] 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 354ad2f commit 5bd7ad6

33 files changed

+2200
-13
lines changed

java-ids/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ If you are using Maven, add this to your pom.xml file:
2727
If you are using Gradle without BOM, add this to your dependencies
2828

2929
```Groovy
30-
implementation 'com.google.cloud:google-cloud-ids:1.1.0'
30+
implementation 'com.google.cloud:google-cloud-ids:1.1.1'
3131
```
3232

3333
If you are using SBT, add this to your dependencies
3434

3535
```Scala
36-
libraryDependencies += "com.google.cloud" % "google-cloud-ids" % "1.1.0"
36+
libraryDependencies += "com.google.cloud" % "google-cloud-ids" % "1.1.1"
3737
```
3838

3939
## Authentication

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,10 @@
5858
<groupId>com.google.api</groupId>
5959
<artifactId>gax-grpc</artifactId>
6060
</dependency>
61+
<dependency>
62+
<groupId>com.google.api</groupId>
63+
<artifactId>gax-httpjson</artifactId>
64+
</dependency>
6165
<dependency>
6266
<groupId>org.threeten</groupId>
6367
<artifactId>threetenbp</artifactId>
@@ -77,12 +81,24 @@
7781
<scope>test</scope>
7882
</dependency>
7983
<!-- Need testing utility classes for generated gRPC clients tests -->
84+
<dependency>
85+
<groupId>com.google.api</groupId>
86+
<artifactId>gax</artifactId>
87+
<classifier>testlib</classifier>
88+
<scope>test</scope>
89+
</dependency>
8090
<dependency>
8191
<groupId>com.google.api</groupId>
8292
<artifactId>gax-grpc</artifactId>
8393
<classifier>testlib</classifier>
8494
<scope>test</scope>
8595
</dependency>
96+
<dependency>
97+
<groupId>com.google.api</groupId>
98+
<artifactId>gax-httpjson</artifactId>
99+
<classifier>testlib</classifier>
100+
<scope>test</scope>
101+
</dependency>
86102
</dependencies>
87103

88104
<profiles>

java-ids/google-cloud-ids/src/main/java/com/google/cloud/ids/v1/IDSClient.java

Lines changed: 32 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import com.google.api.core.ApiFuture;
2020
import com.google.api.core.ApiFutures;
2121
import com.google.api.gax.core.BackgroundResource;
22+
import com.google.api.gax.httpjson.longrunning.OperationsClient;
2223
import com.google.api.gax.longrunning.OperationFuture;
2324
import com.google.api.gax.paging.AbstractFixedSizeCollection;
2425
import com.google.api.gax.paging.AbstractPage;
@@ -30,7 +31,6 @@
3031
import com.google.cloud.ids.v1.stub.IDSStubSettings;
3132
import com.google.common.util.concurrent.MoreExecutors;
3233
import com.google.longrunning.Operation;
33-
import com.google.longrunning.OperationsClient;
3434
import com.google.protobuf.Empty;
3535
import java.io.IOException;
3636
import java.util.List;
@@ -100,13 +100,28 @@
100100
* IDSClient iDSClient = IDSClient.create(iDSSettings);
101101
* }</pre>
102102
*
103+
* <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
104+
* the wire:
105+
*
106+
* <pre>{@code
107+
* // This snippet has been automatically generated for illustrative purposes only.
108+
* // It may require modifications to work in your environment.
109+
* IDSSettings iDSSettings =
110+
* IDSSettings.newBuilder()
111+
* .setTransportChannelProvider(
112+
* IDSSettings.defaultHttpJsonTransportProviderBuilder().build())
113+
* .build();
114+
* IDSClient iDSClient = IDSClient.create(iDSSettings);
115+
* }</pre>
116+
*
103117
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
104118
*/
105119
@Generated("by gapic-generator-java")
106120
public class IDSClient implements BackgroundResource {
107121
private final IDSSettings settings;
108122
private final IDSStub stub;
109-
private final OperationsClient operationsClient;
123+
private final OperationsClient httpJsonOperationsClient;
124+
private final com.google.longrunning.OperationsClient operationsClient;
110125

111126
/** Constructs an instance of IDSClient with default settings. */
112127
public static final IDSClient create() throws IOException {
@@ -136,13 +151,17 @@ public static final IDSClient create(IDSStub stub) {
136151
protected IDSClient(IDSSettings settings) throws IOException {
137152
this.settings = settings;
138153
this.stub = ((IDSStubSettings) settings.getStubSettings()).createStub();
139-
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
154+
this.operationsClient =
155+
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
156+
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
140157
}
141158

142159
protected IDSClient(IDSStub stub) {
143160
this.settings = null;
144161
this.stub = stub;
145-
this.operationsClient = OperationsClient.create(this.stub.getOperationsStub());
162+
this.operationsClient =
163+
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
164+
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
146165
}
147166

148167
public final IDSSettings getSettings() {
@@ -157,10 +176,18 @@ public IDSStub getStub() {
157176
* Returns the OperationsClient that can be used to query the status of a long-running operation
158177
* returned by another API method call.
159178
*/
160-
public final OperationsClient getOperationsClient() {
179+
public final com.google.longrunning.OperationsClient getOperationsClient() {
161180
return operationsClient;
162181
}
163182

183+
/**
184+
* Returns the OperationsClient that can be used to query the status of a long-running operation
185+
* returned by another API method call.
186+
*/
187+
public final OperationsClient getHttpJsonOperationsClient() {
188+
return httpJsonOperationsClient;
189+
}
190+
164191
// AUTO-GENERATED DOCUMENTATION AND METHOD.
165192
/**
166193
* Lists Endpoints in a given project and location.

java-ids/google-cloud-ids/src/main/java/com/google/cloud/ids/v1/IDSSettings.java

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import com.google.api.gax.core.GoogleCredentialsProvider;
2424
import com.google.api.gax.core.InstantiatingExecutorProvider;
2525
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
26+
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
2627
import com.google.api.gax.rpc.ApiClientHeaderProvider;
2728
import com.google.api.gax.rpc.ClientContext;
2829
import com.google.api.gax.rpc.ClientSettings;
@@ -130,11 +131,18 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
130131
return IDSStubSettings.defaultCredentialsProviderBuilder();
131132
}
132133

133-
/** Returns a builder for the default ChannelProvider for this service. */
134+
/** Returns a builder for the default gRPC ChannelProvider for this service. */
134135
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
135136
return IDSStubSettings.defaultGrpcTransportProviderBuilder();
136137
}
137138

139+
/** Returns a builder for the default REST ChannelProvider for this service. */
140+
@BetaApi
141+
public static InstantiatingHttpJsonChannelProvider.Builder
142+
defaultHttpJsonTransportProviderBuilder() {
143+
return IDSStubSettings.defaultHttpJsonTransportProviderBuilder();
144+
}
145+
138146
public static TransportChannelProvider defaultTransportChannelProvider() {
139147
return IDSStubSettings.defaultTransportChannelProvider();
140148
}
@@ -144,11 +152,17 @@ public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuil
144152
return IDSStubSettings.defaultApiClientHeaderProviderBuilder();
145153
}
146154

147-
/** Returns a new builder for this class. */
155+
/** Returns a new gRPC builder for this class. */
148156
public static Builder newBuilder() {
149157
return Builder.createDefault();
150158
}
151159

160+
/** Returns a new REST builder for this class. */
161+
@BetaApi
162+
public static Builder newHttpJsonBuilder() {
163+
return Builder.createHttpJsonDefault();
164+
}
165+
152166
/** Returns a new builder for this class. */
153167
public static Builder newBuilder(ClientContext clientContext) {
154168
return new Builder(clientContext);
@@ -186,6 +200,11 @@ private static Builder createDefault() {
186200
return new Builder(IDSStubSettings.newBuilder());
187201
}
188202

203+
@BetaApi
204+
private static Builder createHttpJsonDefault() {
205+
return new Builder(IDSStubSettings.newHttpJsonBuilder());
206+
}
207+
189208
public IDSStubSettings.Builder getStubSettingsBuilder() {
190209
return ((IDSStubSettings.Builder) getStubSettings());
191210
}
Lines changed: 105 additions & 0 deletions
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.ids.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 IDS service API.
40+
*
41+
* <p>This class is for advanced usage.
42+
*/
43+
@Generated("by gapic-generator-java")
44+
@BetaApi
45+
public class HttpJsonIDSCallableFactory
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)