Skip to content

Commit cfd43f0

Browse files
fix!: rename the 'page_size', 'page_token', 'total_size' fields to 'limit', 'offset' and 'row_count' respectively (googleapis#170)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/cc709e90-a49a-42d6-a4ad-ab9e235da65b/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 361182102 Source-Link: googleapis/googleapis@d4cd8d9 Source-Link: googleapis/googleapis-gen@18e1811
1 parent 6d06098 commit cfd43f0

21 files changed

+646
-1177
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!-- see http://www.mojohaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
3+
<differences>
4+
<difference>
5+
<differenceType>7002</differenceType>
6+
<className>com/google/analytics/data/v1beta/stub/*Stub*</className>
7+
<method>* runReport*(*)</method>
8+
</difference>
9+
<difference>
10+
<differenceType>7002</differenceType>
11+
<className>com/google/analytics/data/v1beta/BetaAnalytics*</className>
12+
<method>* runReport*(*)</method>
13+
</difference>
14+
<difference>
15+
<differenceType>7006</differenceType>
16+
<className>com/google/analytics/data/v1beta/BetaAnalytics*</className>
17+
<method>* runReport*(*)</method>
18+
<to>*</to>
19+
</difference>
20+
<difference>
21+
<differenceType>7006</differenceType>
22+
<className>com/google/analytics/data/v1beta/stub/BetaAnalytics*</className>
23+
<method>* runReport*(*)</method>
24+
<to>*</to>
25+
</difference>
26+
<difference>
27+
<differenceType>8001</differenceType>
28+
<className>com/google/analytics/data/v1beta/BetaAnalytics*</className>
29+
</difference>
30+
31+
</differences>

google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataClient.java

Lines changed: 19 additions & 140 deletions
Original file line numberDiff line numberDiff line change
@@ -18,19 +18,10 @@
1818

1919
import com.google.analytics.data.v1beta.stub.BetaAnalyticsDataStub;
2020
import com.google.analytics.data.v1beta.stub.BetaAnalyticsDataStubSettings;
21-
import com.google.api.core.ApiFunction;
22-
import com.google.api.core.ApiFuture;
23-
import com.google.api.core.ApiFutures;
2421
import com.google.api.core.BetaApi;
2522
import com.google.api.gax.core.BackgroundResource;
26-
import com.google.api.gax.paging.AbstractFixedSizeCollection;
27-
import com.google.api.gax.paging.AbstractPage;
28-
import com.google.api.gax.paging.AbstractPagedListResponse;
29-
import com.google.api.gax.rpc.PageContext;
3023
import com.google.api.gax.rpc.UnaryCallable;
31-
import com.google.common.util.concurrent.MoreExecutors;
3224
import java.io.IOException;
33-
import java.util.List;
3425
import java.util.concurrent.TimeUnit;
3526
import javax.annotation.Generated;
3627

@@ -43,21 +34,24 @@
4334
*
4435
* <pre>{@code
4536
* try (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
46-
* RunPivotReportRequest request =
47-
* RunPivotReportRequest.newBuilder()
37+
* RunReportRequest request =
38+
* RunReportRequest.newBuilder()
4839
* .setProperty("property-993141291")
4940
* .addAllDimensions(new ArrayList<Dimension>())
5041
* .addAllMetrics(new ArrayList<Metric>())
5142
* .addAllDateRanges(new ArrayList<DateRange>())
52-
* .addAllPivots(new ArrayList<Pivot>())
5343
* .setDimensionFilter(FilterExpression.newBuilder().build())
5444
* .setMetricFilter(FilterExpression.newBuilder().build())
45+
* .setOffset(-1019779949)
46+
* .setLimit(102976443)
47+
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
48+
* .addAllOrderBys(new ArrayList<OrderBy>())
5549
* .setCurrencyCode("currencyCode1004773790")
5650
* .setCohortSpec(CohortSpec.newBuilder().build())
5751
* .setKeepEmptyRows(true)
5852
* .setReturnPropertyQuota(true)
5953
* .build();
60-
* RunPivotReportResponse response = betaAnalyticsDataClient.runPivotReport(request);
54+
* RunReportResponse response = betaAnalyticsDataClient.runReport(request);
6155
* }
6256
* }</pre>
6357
*
@@ -184,26 +178,24 @@ public BetaAnalyticsDataStub getStub() {
184178
* .addAllDateRanges(new ArrayList<DateRange>())
185179
* .setDimensionFilter(FilterExpression.newBuilder().build())
186180
* .setMetricFilter(FilterExpression.newBuilder().build())
187-
* .setPageSize(883849137)
188-
* .setPageToken("pageToken873572522")
181+
* .setOffset(-1019779949)
182+
* .setLimit(102976443)
189183
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
190184
* .addAllOrderBys(new ArrayList<OrderBy>())
191185
* .setCurrencyCode("currencyCode1004773790")
192186
* .setCohortSpec(CohortSpec.newBuilder().build())
193187
* .setKeepEmptyRows(true)
194188
* .setReturnPropertyQuota(true)
195189
* .build();
196-
* for (DimensionHeader element : betaAnalyticsDataClient.runReport(request).iterateAll()) {
197-
* // doThingsWith(element);
198-
* }
190+
* RunReportResponse response = betaAnalyticsDataClient.runReport(request);
199191
* }
200192
* }</pre>
201193
*
202194
* @param request The request object containing all of the parameters for the API call.
203195
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
204196
*/
205-
public final RunReportPagedResponse runReport(RunReportRequest request) {
206-
return runReportPagedCallable().call(request);
197+
public final RunReportResponse runReport(RunReportRequest request) {
198+
return runReportCallable().call(request);
207199
}
208200

209201
// AUTO-GENERATED DOCUMENTATION AND METHOD.
@@ -226,52 +218,19 @@ public final RunReportPagedResponse runReport(RunReportRequest request) {
226218
* .addAllDateRanges(new ArrayList<DateRange>())
227219
* .setDimensionFilter(FilterExpression.newBuilder().build())
228220
* .setMetricFilter(FilterExpression.newBuilder().build())
229-
* .setPageSize(883849137)
230-
* .setPageToken("pageToken873572522")
221+
* .setOffset(-1019779949)
222+
* .setLimit(102976443)
231223
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
232224
* .addAllOrderBys(new ArrayList<OrderBy>())
233225
* .setCurrencyCode("currencyCode1004773790")
234226
* .setCohortSpec(CohortSpec.newBuilder().build())
235227
* .setKeepEmptyRows(true)
236228
* .setReturnPropertyQuota(true)
237229
* .build();
238-
* ApiFuture<DimensionHeader> future =
239-
* betaAnalyticsDataClient.runReportPagedCallable().futureCall(request);
230+
* ApiFuture<RunReportResponse> future =
231+
* betaAnalyticsDataClient.runReportCallable().futureCall(request);
240232
* // Do something.
241-
* for (DimensionHeader element : future.get().iterateAll()) {
242-
* // doThingsWith(element);
243-
* }
244-
* }
245-
* }</pre>
246-
*/
247-
public final UnaryCallable<RunReportRequest, RunReportPagedResponse> runReportPagedCallable() {
248-
return stub.runReportPagedCallable();
249-
}
250-
251-
// AUTO-GENERATED DOCUMENTATION AND METHOD.
252-
/**
253-
* Returns a customized report of your Google Analytics event data. Reports contain statistics
254-
* derived from data collected by the Google Analytics tracking code. The data returned from the
255-
* API is as a table with columns for the requested dimensions and metrics. Metrics are individual
256-
* measurements of user activity on your property, such as active users or event count. Dimensions
257-
* break down metrics across some common criteria, such as country or event name.
258-
*
259-
* <p>Sample code:
260-
*
261-
* <pre>{@code
262-
* try (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
263-
* while (true) {
264-
* RunReportResponse response = betaAnalyticsDataClient.runReportCallable().call(request);
265-
* for (DimensionHeader element : response.getResponsesList()) {
266-
* // doThingsWith(element);
267-
* }
268-
* String nextPageToken = response.getNextPageToken();
269-
* if (!Strings.isNullOrEmpty(nextPageToken)) {
270-
* request = request.toBuilder().setPageToken(nextPageToken).build();
271-
* } else {
272-
* break;
273-
* }
274-
* }
233+
* RunReportResponse response = future.get();
275234
* }
276235
* }</pre>
277236
*/
@@ -592,7 +551,7 @@ public final UnaryCallable<GetMetadataRequest, Metadata> getMetadataCallable() {
592551
* .addAllMetrics(new ArrayList<Metric>())
593552
* .setDimensionFilter(FilterExpression.newBuilder().build())
594553
* .setMetricFilter(FilterExpression.newBuilder().build())
595-
* .setPageSize(883849137)
554+
* .setLimit(102976443)
596555
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
597556
* .addAllOrderBys(new ArrayList<OrderBy>())
598557
* .setReturnPropertyQuota(true)
@@ -624,7 +583,7 @@ public final RunRealtimeReportResponse runRealtimeReport(RunRealtimeReportReques
624583
* .addAllMetrics(new ArrayList<Metric>())
625584
* .setDimensionFilter(FilterExpression.newBuilder().build())
626585
* .setMetricFilter(FilterExpression.newBuilder().build())
627-
* .setPageSize(883849137)
586+
* .setLimit(102976443)
628587
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
629588
* .addAllOrderBys(new ArrayList<OrderBy>())
630589
* .setReturnPropertyQuota(true)
@@ -670,84 +629,4 @@ public void shutdownNow() {
670629
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
671630
return stub.awaitTermination(duration, unit);
672631
}
673-
674-
public static class RunReportPagedResponse
675-
extends AbstractPagedListResponse<
676-
RunReportRequest,
677-
RunReportResponse,
678-
DimensionHeader,
679-
RunReportPage,
680-
RunReportFixedSizeCollection> {
681-
682-
public static ApiFuture<RunReportPagedResponse> createAsync(
683-
PageContext<RunReportRequest, RunReportResponse, DimensionHeader> context,
684-
ApiFuture<RunReportResponse> futureResponse) {
685-
ApiFuture<RunReportPage> futurePage =
686-
RunReportPage.createEmptyPage().createPageAsync(context, futureResponse);
687-
return ApiFutures.transform(
688-
futurePage,
689-
new ApiFunction<RunReportPage, RunReportPagedResponse>() {
690-
@Override
691-
public RunReportPagedResponse apply(RunReportPage input) {
692-
return new RunReportPagedResponse(input);
693-
}
694-
},
695-
MoreExecutors.directExecutor());
696-
}
697-
698-
private RunReportPagedResponse(RunReportPage page) {
699-
super(page, RunReportFixedSizeCollection.createEmptyCollection());
700-
}
701-
}
702-
703-
public static class RunReportPage
704-
extends AbstractPage<RunReportRequest, RunReportResponse, DimensionHeader, RunReportPage> {
705-
706-
private RunReportPage(
707-
PageContext<RunReportRequest, RunReportResponse, DimensionHeader> context,
708-
RunReportResponse response) {
709-
super(context, response);
710-
}
711-
712-
private static RunReportPage createEmptyPage() {
713-
return new RunReportPage(null, null);
714-
}
715-
716-
@Override
717-
protected RunReportPage createPage(
718-
PageContext<RunReportRequest, RunReportResponse, DimensionHeader> context,
719-
RunReportResponse response) {
720-
return new RunReportPage(context, response);
721-
}
722-
723-
@Override
724-
public ApiFuture<RunReportPage> createPageAsync(
725-
PageContext<RunReportRequest, RunReportResponse, DimensionHeader> context,
726-
ApiFuture<RunReportResponse> futureResponse) {
727-
return super.createPageAsync(context, futureResponse);
728-
}
729-
}
730-
731-
public static class RunReportFixedSizeCollection
732-
extends AbstractFixedSizeCollection<
733-
RunReportRequest,
734-
RunReportResponse,
735-
DimensionHeader,
736-
RunReportPage,
737-
RunReportFixedSizeCollection> {
738-
739-
private RunReportFixedSizeCollection(List<RunReportPage> pages, int collectionSize) {
740-
super(pages, collectionSize);
741-
}
742-
743-
private static RunReportFixedSizeCollection createEmptyCollection() {
744-
return new RunReportFixedSizeCollection(null, 0);
745-
}
746-
747-
@Override
748-
protected RunReportFixedSizeCollection createCollection(
749-
List<RunReportPage> pages, int collectionSize) {
750-
return new RunReportFixedSizeCollection(pages, collectionSize);
751-
}
752-
}
753632
}

google-analytics-data/src/main/java/com/google/analytics/data/v1beta/BetaAnalyticsDataSettings.java

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616

1717
package com.google.analytics.data.v1beta;
1818

19-
import static com.google.analytics.data.v1beta.BetaAnalyticsDataClient.RunReportPagedResponse;
20-
2119
import com.google.analytics.data.v1beta.stub.BetaAnalyticsDataStubSettings;
2220
import com.google.api.core.ApiFunction;
2321
import com.google.api.core.BetaApi;
@@ -27,7 +25,6 @@
2725
import com.google.api.gax.rpc.ApiClientHeaderProvider;
2826
import com.google.api.gax.rpc.ClientContext;
2927
import com.google.api.gax.rpc.ClientSettings;
30-
import com.google.api.gax.rpc.PagedCallSettings;
3128
import com.google.api.gax.rpc.TransportChannelProvider;
3229
import com.google.api.gax.rpc.UnaryCallSettings;
3330
import java.io.IOException;
@@ -49,16 +46,16 @@
4946
* <p>The builder of this class is recursive, so contained classes are themselves builders. When
5047
* build() is called, the tree of builders is called to create the complete settings object.
5148
*
52-
* <p>For example, to set the total timeout of runPivotReport to 30 seconds:
49+
* <p>For example, to set the total timeout of runReport to 30 seconds:
5350
*
5451
* <pre>{@code
5552
* BetaAnalyticsDataSettings.Builder betaAnalyticsDataSettingsBuilder =
5653
* BetaAnalyticsDataSettings.newBuilder();
5754
* betaAnalyticsDataSettingsBuilder
58-
* .runPivotReportSettings()
55+
* .runReportSettings()
5956
* .setRetrySettings(
6057
* betaAnalyticsDataSettingsBuilder
61-
* .runPivotReportSettings()
58+
* .runReportSettings()
6259
* .getRetrySettings()
6360
* .toBuilder()
6461
* .setTotalTimeout(Duration.ofSeconds(30))
@@ -71,8 +68,7 @@
7168
public class BetaAnalyticsDataSettings extends ClientSettings<BetaAnalyticsDataSettings> {
7269

7370
/** Returns the object with the settings used for calls to runReport. */
74-
public PagedCallSettings<RunReportRequest, RunReportResponse, RunReportPagedResponse>
75-
runReportSettings() {
71+
public UnaryCallSettings<RunReportRequest, RunReportResponse> runReportSettings() {
7672
return ((BetaAnalyticsDataStubSettings) getStubSettings()).runReportSettings();
7773
}
7874

@@ -203,8 +199,7 @@ public Builder applyToAllUnaryMethods(
203199
}
204200

205201
/** Returns the builder for the settings used for calls to runReport. */
206-
public PagedCallSettings.Builder<RunReportRequest, RunReportResponse, RunReportPagedResponse>
207-
runReportSettings() {
202+
public UnaryCallSettings.Builder<RunReportRequest, RunReportResponse> runReportSettings() {
208203
return getStubSettingsBuilder().runReportSettings();
209204
}
210205

google-analytics-data/src/main/java/com/google/analytics/data/v1beta/gapic_metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
"methods": ["runRealtimeReport", "runRealtimeReportCallable"]
2727
},
2828
"RunReport": {
29-
"methods": ["runReport", "runReportPagedCallable", "runReportCallable"]
29+
"methods": ["runReport", "runReportCallable"]
3030
}
3131
}
3232
}

google-analytics-data/src/main/java/com/google/analytics/data/v1beta/package-info.java

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,21 +25,24 @@
2525
*
2626
* <pre>{@code
2727
* try (BetaAnalyticsDataClient betaAnalyticsDataClient = BetaAnalyticsDataClient.create()) {
28-
* RunPivotReportRequest request =
29-
* RunPivotReportRequest.newBuilder()
28+
* RunReportRequest request =
29+
* RunReportRequest.newBuilder()
3030
* .setProperty("property-993141291")
3131
* .addAllDimensions(new ArrayList<Dimension>())
3232
* .addAllMetrics(new ArrayList<Metric>())
3333
* .addAllDateRanges(new ArrayList<DateRange>())
34-
* .addAllPivots(new ArrayList<Pivot>())
3534
* .setDimensionFilter(FilterExpression.newBuilder().build())
3635
* .setMetricFilter(FilterExpression.newBuilder().build())
36+
* .setOffset(-1019779949)
37+
* .setLimit(102976443)
38+
* .addAllMetricAggregations(new ArrayList<MetricAggregation>())
39+
* .addAllOrderBys(new ArrayList<OrderBy>())
3740
* .setCurrencyCode("currencyCode1004773790")
3841
* .setCohortSpec(CohortSpec.newBuilder().build())
3942
* .setKeepEmptyRows(true)
4043
* .setReturnPropertyQuota(true)
4144
* .build();
42-
* RunPivotReportResponse response = betaAnalyticsDataClient.runPivotReport(request);
45+
* RunReportResponse response = betaAnalyticsDataClient.runReport(request);
4346
* }
4447
* }</pre>
4548
*/

google-analytics-data/src/main/java/com/google/analytics/data/v1beta/stub/BetaAnalyticsDataStub.java

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616

1717
package com.google.analytics.data.v1beta.stub;
1818

19-
import static com.google.analytics.data.v1beta.BetaAnalyticsDataClient.RunReportPagedResponse;
20-
2119
import com.google.analytics.data.v1beta.BatchRunPivotReportsRequest;
2220
import com.google.analytics.data.v1beta.BatchRunPivotReportsResponse;
2321
import com.google.analytics.data.v1beta.BatchRunReportsRequest;
@@ -45,10 +43,6 @@
4543
@Generated("by gapic-generator-java")
4644
public abstract class BetaAnalyticsDataStub implements BackgroundResource {
4745

48-
public UnaryCallable<RunReportRequest, RunReportPagedResponse> runReportPagedCallable() {
49-
throw new UnsupportedOperationException("Not implemented: runReportPagedCallable()");
50-
}
51-
5246
public UnaryCallable<RunReportRequest, RunReportResponse> runReportCallable() {
5347
throw new UnsupportedOperationException("Not implemented: runReportCallable()");
5448
}

0 commit comments

Comments
 (0)