Skip to content
This repository was archived by the owner on Jan 22, 2024. It is now read-only.

Commit 7931f8f

Browse files
yoshi-automationyoshi-automation
authored
feat: GetMetadata method renamed to GetUniversalMetdata docs: documentation updates (#40)
This PR was generated using Autosynth. 🌈 Synth log will be available here: https://source.cloud.google.com/results/invocations/90eeacef-5448-4d12-bd9b-3330f62d6740/targets - [ ] To automatically regenerate this PR, check this box. PiperOrigin-RevId: 335470104 Source-Link: googleapis/googleapis@c3c1296
1 parent 80c8269 commit 7931f8f

File tree

24 files changed

+620
-1198
lines changed

24 files changed

+620
-1198
lines changed

‎google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataClient.java‎

Lines changed: 17 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
* <pre>
3535
* <code>
3636
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
37-
* MetadataName name = MetadataName.ofMetadataName();
38-
* Metadata response = alphaAnalyticsDataClient.getMetadata(name);
37+
* RunReportRequest request = RunReportRequest.newBuilder().build();
38+
* RunReportResponse response = alphaAnalyticsDataClient.runReport(request);
3939
* }
4040
* </code>
4141
* </pre>
@@ -325,74 +325,23 @@ public final BatchRunPivotReportsResponse batchRunPivotReports(
325325
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
326326
* deletions may occur.
327327
*
328-
* <p>Sample code:
329-
*
330-
* <pre><code>
331-
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
332-
* MetadataName name = MetadataName.ofMetadataName();
333-
* Metadata response = alphaAnalyticsDataClient.getMetadata(name);
334-
* }
335-
* </code></pre>
336-
*
337-
* @param name Required. The name of the metadata to retrieve. Either has the form 'metadata' or
338-
* 'properties/{property}/metadata'. This name field is specified in the URL path and not URL
339-
* parameters. Property is a numeric Google Analytics App + Web Property Id.
340-
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
341-
*/
342-
public final Metadata getMetadata(MetadataName name) {
343-
GetMetadataRequest request =
344-
GetMetadataRequest.newBuilder().setName(name == null ? null : name.toString()).build();
345-
return getMetadata(request);
346-
}
347-
348-
// AUTO-GENERATED DOCUMENTATION AND METHOD
349-
/**
350-
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
351-
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
352-
* deletions may occur.
353-
*
354-
* <p>Sample code:
355-
*
356-
* <pre><code>
357-
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
358-
* MetadataName name = MetadataName.ofMetadataName();
359-
* Metadata response = alphaAnalyticsDataClient.getMetadata(name.toString());
360-
* }
361-
* </code></pre>
362-
*
363-
* @param name Required. The name of the metadata to retrieve. Either has the form 'metadata' or
364-
* 'properties/{property}/metadata'. This name field is specified in the URL path and not URL
365-
* parameters. Property is a numeric Google Analytics App + Web Property Id.
366-
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
367-
*/
368-
public final Metadata getMetadata(String name) {
369-
GetMetadataRequest request = GetMetadataRequest.newBuilder().setName(name).build();
370-
return getMetadata(request);
371-
}
372-
373-
// AUTO-GENERATED DOCUMENTATION AND METHOD
374-
/**
375-
* Returns metadata for dimensions and metrics available in reporting methods. Used to explore the
376-
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
377-
* deletions may occur.
328+
* <p>This method returns Universal Metadata. Universal Metadata are dimensions and metrics
329+
* applicable to any property such as `country` and `totalUsers`.
378330
*
379331
* <p>Sample code:
380332
*
381333
* <pre><code>
382334
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
383-
* MetadataName name = MetadataName.ofMetadataName();
384-
* GetMetadataRequest request = GetMetadataRequest.newBuilder()
385-
* .setName(name.toString())
386-
* .build();
387-
* Metadata response = alphaAnalyticsDataClient.getMetadata(request);
335+
* GetUniversalMetadataRequest request = GetUniversalMetadataRequest.newBuilder().build();
336+
* UniversalMetadata response = alphaAnalyticsDataClient.getUniversalMetadata(request);
388337
* }
389338
* </code></pre>
390339
*
391340
* @param request The request object containing all of the parameters for the API call.
392341
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
393342
*/
394-
public final Metadata getMetadata(GetMetadataRequest request) {
395-
return getMetadataCallable().call(request);
343+
public final UniversalMetadata getUniversalMetadata(GetUniversalMetadataRequest request) {
344+
return getUniversalMetadataCallable().call(request);
396345
}
397346

398347
// AUTO-GENERATED DOCUMENTATION AND METHOD
@@ -401,22 +350,23 @@ public final Metadata getMetadata(GetMetadataRequest request) {
401350
* dimensions and metrics. Dimensions and metrics will be mostly added over time, but renames and
402351
* deletions may occur.
403352
*
353+
* <p>This method returns Universal Metadata. Universal Metadata are dimensions and metrics
354+
* applicable to any property such as `country` and `totalUsers`.
355+
*
404356
* <p>Sample code:
405357
*
406358
* <pre><code>
407359
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
408-
* MetadataName name = MetadataName.ofMetadataName();
409-
* GetMetadataRequest request = GetMetadataRequest.newBuilder()
410-
* .setName(name.toString())
411-
* .build();
412-
* ApiFuture&lt;Metadata&gt; future = alphaAnalyticsDataClient.getMetadataCallable().futureCall(request);
360+
* GetUniversalMetadataRequest request = GetUniversalMetadataRequest.newBuilder().build();
361+
* ApiFuture&lt;UniversalMetadata&gt; future = alphaAnalyticsDataClient.getUniversalMetadataCallable().futureCall(request);
413362
* // Do something
414-
* Metadata response = future.get();
363+
* UniversalMetadata response = future.get();
415364
* }
416365
* </code></pre>
417366
*/
418-
public final UnaryCallable<GetMetadataRequest, Metadata> getMetadataCallable() {
419-
return stub.getMetadataCallable();
367+
public final UnaryCallable<GetUniversalMetadataRequest, UniversalMetadata>
368+
getUniversalMetadataCallable() {
369+
return stub.getUniversalMetadataCallable();
420370
}
421371

422372
@Override

‎google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/AlphaAnalyticsDataSettings.java‎

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -45,16 +45,16 @@
4545
* <p>The builder of this class is recursive, so contained classes are themselves builders. When
4646
* build() is called, the tree of builders is called to create the complete settings object.
4747
*
48-
* <p>For example, to set the total timeout of getMetadata to 30 seconds:
48+
* <p>For example, to set the total timeout of runReport to 30 seconds:
4949
*
5050
* <pre>
5151
* <code>
5252
* AlphaAnalyticsDataSettings.Builder alphaAnalyticsDataSettingsBuilder =
5353
* AlphaAnalyticsDataSettings.newBuilder();
5454
* alphaAnalyticsDataSettingsBuilder
55-
* .getMetadataSettings()
55+
* .runReportSettings()
5656
* .setRetrySettings(
57-
* alphaAnalyticsDataSettingsBuilder.getMetadataSettings().getRetrySettings().toBuilder()
57+
* alphaAnalyticsDataSettingsBuilder.runReportSettings().getRetrySettings().toBuilder()
5858
* .setTotalTimeout(Duration.ofSeconds(30))
5959
* .build());
6060
* AlphaAnalyticsDataSettings alphaAnalyticsDataSettings = alphaAnalyticsDataSettingsBuilder.build();
@@ -86,9 +86,10 @@ public UnaryCallSettings<RunPivotReportRequest, RunPivotReportResponse> runPivot
8686
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).batchRunPivotReportsSettings();
8787
}
8888

89-
/** Returns the object with the settings used for calls to getMetadata. */
90-
public UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings() {
91-
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).getMetadataSettings();
89+
/** Returns the object with the settings used for calls to getUniversalMetadata. */
90+
public UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
91+
getUniversalMetadataSettings() {
92+
return ((AlphaAnalyticsDataStubSettings) getStubSettings()).getUniversalMetadataSettings();
9293
}
9394

9495
public static final AlphaAnalyticsDataSettings create(AlphaAnalyticsDataStubSettings stub)
@@ -211,9 +212,10 @@ public UnaryCallSettings.Builder<RunReportRequest, RunReportResponse> runReportS
211212
return getStubSettingsBuilder().batchRunPivotReportsSettings();
212213
}
213214

214-
/** Returns the builder for the settings used for calls to getMetadata. */
215-
public UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings() {
216-
return getStubSettingsBuilder().getMetadataSettings();
215+
/** Returns the builder for the settings used for calls to getUniversalMetadata. */
216+
public UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
217+
getUniversalMetadataSettings() {
218+
return getStubSettingsBuilder().getUniversalMetadataSettings();
217219
}
218220

219221
@Override

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
* <pre>
2929
* <code>
3030
* try (AlphaAnalyticsDataClient alphaAnalyticsDataClient = AlphaAnalyticsDataClient.create()) {
31-
* MetadataName name = MetadataName.ofMetadataName();
32-
* Metadata response = alphaAnalyticsDataClient.getMetadata(name);
31+
* RunReportRequest request = RunReportRequest.newBuilder().build();
32+
* RunReportResponse response = alphaAnalyticsDataClient.runReport(request);
3333
* }
3434
* </code>
3535
* </pre>

‎google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStub.java‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
import com.google.analytics.data.v1alpha.BatchRunPivotReportsResponse;
2020
import com.google.analytics.data.v1alpha.BatchRunReportsRequest;
2121
import com.google.analytics.data.v1alpha.BatchRunReportsResponse;
22-
import com.google.analytics.data.v1alpha.GetMetadataRequest;
23-
import com.google.analytics.data.v1alpha.Metadata;
22+
import com.google.analytics.data.v1alpha.GetUniversalMetadataRequest;
2423
import com.google.analytics.data.v1alpha.RunPivotReportRequest;
2524
import com.google.analytics.data.v1alpha.RunPivotReportResponse;
2625
import com.google.analytics.data.v1alpha.RunReportRequest;
2726
import com.google.analytics.data.v1alpha.RunReportResponse;
27+
import com.google.analytics.data.v1alpha.UniversalMetadata;
2828
import com.google.api.core.BetaApi;
2929
import com.google.api.gax.core.BackgroundResource;
3030
import com.google.api.gax.rpc.UnaryCallable;
@@ -57,8 +57,9 @@ public UnaryCallable<BatchRunReportsRequest, BatchRunReportsResponse> batchRunRe
5757
throw new UnsupportedOperationException("Not implemented: batchRunPivotReportsCallable()");
5858
}
5959

60-
public UnaryCallable<GetMetadataRequest, Metadata> getMetadataCallable() {
61-
throw new UnsupportedOperationException("Not implemented: getMetadataCallable()");
60+
public UnaryCallable<GetUniversalMetadataRequest, UniversalMetadata>
61+
getUniversalMetadataCallable() {
62+
throw new UnsupportedOperationException("Not implemented: getUniversalMetadataCallable()");
6263
}
6364

6465
@Override

‎google-analytics-data/src/main/java/com/google/analytics/data/v1alpha/stub/AlphaAnalyticsDataStubSettings.java‎

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@
1919
import com.google.analytics.data.v1alpha.BatchRunPivotReportsResponse;
2020
import com.google.analytics.data.v1alpha.BatchRunReportsRequest;
2121
import com.google.analytics.data.v1alpha.BatchRunReportsResponse;
22-
import com.google.analytics.data.v1alpha.GetMetadataRequest;
23-
import com.google.analytics.data.v1alpha.Metadata;
22+
import com.google.analytics.data.v1alpha.GetUniversalMetadataRequest;
2423
import com.google.analytics.data.v1alpha.RunPivotReportRequest;
2524
import com.google.analytics.data.v1alpha.RunPivotReportResponse;
2625
import com.google.analytics.data.v1alpha.RunReportRequest;
2726
import com.google.analytics.data.v1alpha.RunReportResponse;
27+
import com.google.analytics.data.v1alpha.UniversalMetadata;
2828
import com.google.api.core.ApiFunction;
2929
import com.google.api.core.BetaApi;
3030
import com.google.api.gax.core.GaxProperties;
@@ -64,16 +64,16 @@
6464
* <p>The builder of this class is recursive, so contained classes are themselves builders. When
6565
* build() is called, the tree of builders is called to create the complete settings object.
6666
*
67-
* <p>For example, to set the total timeout of getMetadata to 30 seconds:
67+
* <p>For example, to set the total timeout of runReport to 30 seconds:
6868
*
6969
* <pre>
7070
* <code>
7171
* AlphaAnalyticsDataStubSettings.Builder alphaAnalyticsDataSettingsBuilder =
7272
* AlphaAnalyticsDataStubSettings.newBuilder();
7373
* alphaAnalyticsDataSettingsBuilder
74-
* .getMetadataSettings()
74+
* .runReportSettings()
7575
* .setRetrySettings(
76-
* alphaAnalyticsDataSettingsBuilder.getMetadataSettings().getRetrySettings().toBuilder()
76+
* alphaAnalyticsDataSettingsBuilder.runReportSettings().getRetrySettings().toBuilder()
7777
* .setTotalTimeout(Duration.ofSeconds(30))
7878
* .build());
7979
* AlphaAnalyticsDataStubSettings alphaAnalyticsDataSettings = alphaAnalyticsDataSettingsBuilder.build();
@@ -97,7 +97,8 @@ public class AlphaAnalyticsDataStubSettings extends StubSettings<AlphaAnalyticsD
9797
batchRunReportsSettings;
9898
private final UnaryCallSettings<BatchRunPivotReportsRequest, BatchRunPivotReportsResponse>
9999
batchRunPivotReportsSettings;
100-
private final UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings;
100+
private final UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
101+
getUniversalMetadataSettings;
101102

102103
/** Returns the object with the settings used for calls to runReport. */
103104
public UnaryCallSettings<RunReportRequest, RunReportResponse> runReportSettings() {
@@ -121,9 +122,10 @@ public UnaryCallSettings<RunPivotReportRequest, RunPivotReportResponse> runPivot
121122
return batchRunPivotReportsSettings;
122123
}
123124

124-
/** Returns the object with the settings used for calls to getMetadata. */
125-
public UnaryCallSettings<GetMetadataRequest, Metadata> getMetadataSettings() {
126-
return getMetadataSettings;
125+
/** Returns the object with the settings used for calls to getUniversalMetadata. */
126+
public UnaryCallSettings<GetUniversalMetadataRequest, UniversalMetadata>
127+
getUniversalMetadataSettings() {
128+
return getUniversalMetadataSettings;
127129
}
128130

129131
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
@@ -199,7 +201,7 @@ protected AlphaAnalyticsDataStubSettings(Builder settingsBuilder) throws IOExcep
199201
runPivotReportSettings = settingsBuilder.runPivotReportSettings().build();
200202
batchRunReportsSettings = settingsBuilder.batchRunReportsSettings().build();
201203
batchRunPivotReportsSettings = settingsBuilder.batchRunPivotReportsSettings().build();
202-
getMetadataSettings = settingsBuilder.getMetadataSettings().build();
204+
getUniversalMetadataSettings = settingsBuilder.getUniversalMetadataSettings().build();
203205
}
204206

205207
/** Builder for AlphaAnalyticsDataStubSettings. */
@@ -215,7 +217,8 @@ public static class Builder
215217
private final UnaryCallSettings.Builder<
216218
BatchRunPivotReportsRequest, BatchRunPivotReportsResponse>
217219
batchRunPivotReportsSettings;
218-
private final UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings;
220+
private final UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
221+
getUniversalMetadataSettings;
219222

220223
private static final ImmutableMap<String, ImmutableSet<StatusCode.Code>>
221224
RETRYABLE_CODE_DEFINITIONS;
@@ -276,15 +279,15 @@ protected Builder(ClientContext clientContext) {
276279

277280
batchRunPivotReportsSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
278281

279-
getMetadataSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
282+
getUniversalMetadataSettings = UnaryCallSettings.newUnaryCallSettingsBuilder();
280283

281284
unaryMethodSettingsBuilders =
282285
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
283286
runReportSettings,
284287
runPivotReportSettings,
285288
batchRunReportsSettings,
286289
batchRunPivotReportsSettings,
287-
getMetadataSettings);
290+
getUniversalMetadataSettings);
288291

289292
initDefaults(this);
290293
}
@@ -321,7 +324,7 @@ private static Builder initDefaults(Builder builder) {
321324
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("no_retry_1_params"));
322325

323326
builder
324-
.getMetadataSettings()
327+
.getUniversalMetadataSettings()
325328
.setRetryableCodes(RETRYABLE_CODE_DEFINITIONS.get("retry_policy_1_codes"))
326329
.setRetrySettings(RETRY_PARAM_DEFINITIONS.get("retry_policy_1_params"));
327330

@@ -335,15 +338,15 @@ protected Builder(AlphaAnalyticsDataStubSettings settings) {
335338
runPivotReportSettings = settings.runPivotReportSettings.toBuilder();
336339
batchRunReportsSettings = settings.batchRunReportsSettings.toBuilder();
337340
batchRunPivotReportsSettings = settings.batchRunPivotReportsSettings.toBuilder();
338-
getMetadataSettings = settings.getMetadataSettings.toBuilder();
341+
getUniversalMetadataSettings = settings.getUniversalMetadataSettings.toBuilder();
339342

340343
unaryMethodSettingsBuilders =
341344
ImmutableList.<UnaryCallSettings.Builder<?, ?>>of(
342345
runReportSettings,
343346
runPivotReportSettings,
344347
batchRunReportsSettings,
345348
batchRunPivotReportsSettings,
346-
getMetadataSettings);
349+
getUniversalMetadataSettings);
347350
}
348351

349352
// NEXT_MAJOR_VER: remove 'throws Exception'
@@ -385,9 +388,10 @@ public UnaryCallSettings.Builder<RunReportRequest, RunReportResponse> runReportS
385388
return batchRunPivotReportsSettings;
386389
}
387390

388-
/** Returns the builder for the settings used for calls to getMetadata. */
389-
public UnaryCallSettings.Builder<GetMetadataRequest, Metadata> getMetadataSettings() {
390-
return getMetadataSettings;
391+
/** Returns the builder for the settings used for calls to getUniversalMetadata. */
392+
public UnaryCallSettings.Builder<GetUniversalMetadataRequest, UniversalMetadata>
393+
getUniversalMetadataSettings() {
394+
return getUniversalMetadataSettings;
391395
}
392396

393397
@Override

0 commit comments

Comments
 (0)