Skip to content
This repository was archived by the owner on Sep 25, 2023. It is now read-only.

Commit b56e004

Browse files
feat: Enable REST transport for most of Java and Go clients (#611)
- [ ] 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 18af388 commit b56e004

File tree

7 files changed

+1001
-5
lines changed

7 files changed

+1001
-5
lines changed

google-cloud-monitoring-dashboard/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>
@@ -76,12 +80,24 @@
7680
<scope>test</scope>
7781
</dependency>
7882
<!-- Need testing utility classes for generated gRPC clients tests -->
83+
<dependency>
84+
<groupId>com.google.api</groupId>
85+
<artifactId>gax</artifactId>
86+
<classifier>testlib</classifier>
87+
<scope>test</scope>
88+
</dependency>
7989
<dependency>
8090
<groupId>com.google.api</groupId>
8191
<artifactId>gax-grpc</artifactId>
8292
<classifier>testlib</classifier>
8393
<scope>test</scope>
8494
</dependency>
95+
<dependency>
96+
<groupId>com.google.api</groupId>
97+
<artifactId>gax-httpjson</artifactId>
98+
<classifier>testlib</classifier>
99+
<scope>test</scope>
100+
</dependency>
85101
</dependencies>
86102

87103
<profiles>

google-cloud-monitoring-dashboard/src/main/java/com/google/cloud/monitoring/dashboard/v1/DashboardsServiceClient.java

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,21 @@
113113
* DashboardsServiceClient.create(dashboardsServiceSettings);
114114
* }</pre>
115115
*
116+
* <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
117+
* the wire:
118+
*
119+
* <pre>{@code
120+
* // This snippet has been automatically generated for illustrative purposes only.
121+
* // It may require modifications to work in your environment.
122+
* DashboardsServiceSettings dashboardsServiceSettings =
123+
* DashboardsServiceSettings.newBuilder()
124+
* .setTransportChannelProvider(
125+
* DashboardsServiceSettings.defaultHttpJsonTransportProviderBuilder().build())
126+
* .build();
127+
* DashboardsServiceClient dashboardsServiceClient =
128+
* DashboardsServiceClient.create(dashboardsServiceSettings);
129+
* }</pre>
130+
*
116131
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
117132
*/
118133
@Generated("by gapic-generator-java")

google-cloud-monitoring-dashboard/src/main/java/com/google/cloud/monitoring/dashboard/v1/DashboardsServiceSettings.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;
@@ -131,11 +132,18 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
131132
return DashboardsServiceStubSettings.defaultCredentialsProviderBuilder();
132133
}
133134

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

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

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

161+
/** Returns a new REST builder for this class. */
162+
@BetaApi
163+
public static Builder newHttpJsonBuilder() {
164+
return Builder.createHttpJsonDefault();
165+
}
166+
153167
/** Returns a new builder for this class. */
154168
public static Builder newBuilder(ClientContext clientContext) {
155169
return new Builder(clientContext);
@@ -187,6 +201,11 @@ private static Builder createDefault() {
187201
return new Builder(DashboardsServiceStubSettings.newBuilder());
188202
}
189203

204+
@BetaApi
205+
private static Builder createHttpJsonDefault() {
206+
return new Builder(DashboardsServiceStubSettings.newHttpJsonBuilder());
207+
}
208+
190209
public DashboardsServiceStubSettings.Builder getStubSettingsBuilder() {
191210
return ((DashboardsServiceStubSettings.Builder) getStubSettings());
192211
}

google-cloud-monitoring-dashboard/src/main/java/com/google/cloud/monitoring/dashboard/v1/stub/DashboardsServiceStubSettings.java

Lines changed: 50 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@
2727
import com.google.api.gax.grpc.GaxGrpcProperties;
2828
import com.google.api.gax.grpc.GrpcTransportChannel;
2929
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
30+
import com.google.api.gax.httpjson.GaxHttpJsonProperties;
31+
import com.google.api.gax.httpjson.HttpJsonTransportChannel;
32+
import com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider;
3033
import com.google.api.gax.retrying.RetrySettings;
3134
import com.google.api.gax.rpc.ApiCallContext;
3235
import com.google.api.gax.rpc.ApiClientHeaderProvider;
@@ -198,6 +201,11 @@ public DashboardsServiceStub createStub() throws IOException {
198201
.equals(GrpcTransportChannel.getGrpcTransportName())) {
199202
return GrpcDashboardsServiceStub.create(this);
200203
}
204+
if (getTransportChannelProvider()
205+
.getTransportName()
206+
.equals(HttpJsonTransportChannel.getHttpJsonTransportName())) {
207+
return HttpJsonDashboardsServiceStub.create(this);
208+
}
201209
throw new UnsupportedOperationException(
202210
String.format(
203211
"Transport not supported: %s", getTransportChannelProvider().getTransportName()));
@@ -230,30 +238,56 @@ public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilde
230238
.setUseJwtAccessWithScope(true);
231239
}
232240

233-
/** Returns a builder for the default ChannelProvider for this service. */
241+
/** Returns a builder for the default gRPC ChannelProvider for this service. */
234242
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
235243
return InstantiatingGrpcChannelProvider.newBuilder()
236244
.setMaxInboundMessageSize(Integer.MAX_VALUE);
237245
}
238246

247+
/** Returns a builder for the default REST ChannelProvider for this service. */
248+
@BetaApi
249+
public static InstantiatingHttpJsonChannelProvider.Builder
250+
defaultHttpJsonTransportProviderBuilder() {
251+
return InstantiatingHttpJsonChannelProvider.newBuilder();
252+
}
253+
239254
public static TransportChannelProvider defaultTransportChannelProvider() {
240255
return defaultGrpcTransportProviderBuilder().build();
241256
}
242257

243258
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
244-
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
259+
public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder() {
245260
return ApiClientHeaderProvider.newBuilder()
246261
.setGeneratedLibToken(
247262
"gapic", GaxProperties.getLibraryVersion(DashboardsServiceStubSettings.class))
248263
.setTransportToken(
249264
GaxGrpcProperties.getGrpcTokenName(), GaxGrpcProperties.getGrpcVersion());
250265
}
251266

252-
/** Returns a new builder for this class. */
267+
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
268+
public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder() {
269+
return ApiClientHeaderProvider.newBuilder()
270+
.setGeneratedLibToken(
271+
"gapic", GaxProperties.getLibraryVersion(DashboardsServiceStubSettings.class))
272+
.setTransportToken(
273+
GaxHttpJsonProperties.getHttpJsonTokenName(),
274+
GaxHttpJsonProperties.getHttpJsonVersion());
275+
}
276+
277+
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
278+
return DashboardsServiceStubSettings.defaultGrpcApiClientHeaderProviderBuilder();
279+
}
280+
281+
/** Returns a new gRPC builder for this class. */
253282
public static Builder newBuilder() {
254283
return Builder.createDefault();
255284
}
256285

286+
/** Returns a new REST builder for this class. */
287+
public static Builder newHttpJsonBuilder() {
288+
return Builder.createHttpJsonDefault();
289+
}
290+
257291
/** Returns a new builder for this class. */
258292
public static Builder newBuilder(ClientContext clientContext) {
259293
return new Builder(clientContext);
@@ -383,6 +417,19 @@ private static Builder createDefault() {
383417
return initDefaults(builder);
384418
}
385419

420+
private static Builder createHttpJsonDefault() {
421+
Builder builder = new Builder(((ClientContext) null));
422+
423+
builder.setTransportChannelProvider(defaultHttpJsonTransportProviderBuilder().build());
424+
builder.setCredentialsProvider(defaultCredentialsProviderBuilder().build());
425+
builder.setInternalHeaderProvider(defaultHttpJsonApiClientHeaderProviderBuilder().build());
426+
builder.setEndpoint(getDefaultEndpoint());
427+
builder.setMtlsEndpoint(getDefaultMtlsEndpoint());
428+
builder.setSwitchToMtlsEndpointAllowed(true);
429+
430+
return initDefaults(builder);
431+
}
432+
386433
private static Builder initDefaults(Builder builder) {
387434
builder
388435
.createDashboardSettings()
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.monitoring.dashboard.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 DashboardsService service API.
40+
*
41+
* <p>This class is for advanced usage.
42+
*/
43+
@Generated("by gapic-generator-java")
44+
@BetaApi
45+
public class HttpJsonDashboardsServiceCallableFactory
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)