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

Commit

Permalink
Browse files Browse the repository at this point in the history
…e to the list of acceptable scopes for all read only methods (#179)

This PR was generated using Autosynth. 🌈

Synth log will be available here:
https://source.cloud.google.com/results/invocations/f4db069f-cbbf-4be2-82c8-2112cfa6e279/targets

- [ ] To automatically regenerate this PR, check this box.

PiperOrigin-RevId: 359531616
Source-Link: googleapis/googleapis@2a9e729
Source-Link: googleapis/googleapis-gen@48cbe56

docs: update the documentation of the `update_mask` field used by Update() methods
  • Loading branch information
yoshi-automation committed Mar 2, 2021
1 parent 1e19379 commit e8d6269
Show file tree
Hide file tree
Showing 21 changed files with 543 additions and 431 deletions.
Expand Up @@ -487,9 +487,9 @@ public final UnaryCallable<DeleteAccountRequest, Empty> deleteAccountCallable()
*
* @param account Required. The account to update. The account's `name` field is used to identify
* the account.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Account updateAccount(Account account, FieldMask updateMask) {
Expand Down Expand Up @@ -1096,9 +1096,9 @@ public final UnaryCallable<DeletePropertyRequest, Empty> deletePropertyCallable(
*
* @param property Required. The property to update. The property's `name` field is used to
* identify the property to be updated.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Property updateProperty(Property property, FieldMask updateMask) {
Expand Down Expand Up @@ -2263,9 +2263,9 @@ public final UnaryCallable<DeleteWebDataStreamRequest, Empty> deleteWebDataStrea
*
* @param webDataStream Required. The web stream to update. The `name` field is used to identify
* the web stream to be updated.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final WebDataStream updateWebDataStream(
Expand Down Expand Up @@ -2820,9 +2820,9 @@ public final void deleteIosAppDataStream(DeleteIosAppDataStreamRequest request)
*
* @param iosAppDataStream Required. The iOS app stream to update. The `name` field is used to
* identify the iOS app stream to be updated.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final IosAppDataStream updateIosAppDataStream(
Expand Down Expand Up @@ -2888,7 +2888,13 @@ public final IosAppDataStream updateIosAppDataStream(UpdateIosAppDataStreamReque

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
*
* <p>Note that an iOS app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -2919,7 +2925,13 @@ public final IosAppDataStream createIosAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
*
* <p>Note that an iOS app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -2950,7 +2962,13 @@ public final IosAppDataStream createIosAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
*
* <p>Note that an iOS app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand All @@ -2975,7 +2993,13 @@ public final IosAppDataStream createIosAppDataStream(CreateIosAppDataStreamReque

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
*
* <p>Note that an iOS app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -3388,9 +3412,9 @@ public final void deleteAndroidAppDataStream(DeleteAndroidAppDataStreamRequest r
*
* @param androidAppDataStream Required. The android app stream to update. The `name` field is
* used to identify the android app stream to be updated.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AndroidAppDataStream updateAndroidAppDataStream(
Expand Down Expand Up @@ -3458,7 +3482,13 @@ public final AndroidAppDataStream updateAndroidAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
*
* <p>Note that an Android app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -3489,7 +3519,13 @@ public final AndroidAppDataStream createAndroidAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
*
* <p>Note that an Android app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -3521,7 +3557,13 @@ public final AndroidAppDataStream createAndroidAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
*
* <p>Note that an Android app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -3549,7 +3591,13 @@ public final AndroidAppDataStream createAndroidAppDataStream(

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
*
* <p>Note that an Android app stream must be linked to a Firebase app to receive traffic.
*
* <p>To create a working app stream, make sure your property is linked to a Firebase project.
* Then, use the Firebase API to create a Firebase app, which will also create an appropriate data
* stream in Analytics (may take up to 24 hours).
*
* <p>Sample code:
*
Expand Down Expand Up @@ -3874,9 +3922,9 @@ public final EnhancedMeasurementSettings getEnhancedMeasurementSettings(
*
* @param enhancedMeasurementSettings Required. The settings to update. The `name` field is used
* to identify the settings to be updated.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final EnhancedMeasurementSettings updateEnhancedMeasurementSettings(
Expand Down Expand Up @@ -4077,9 +4125,9 @@ public final UnaryCallable<CreateFirebaseLinkRequest, FirebaseLink> createFireba
* }</pre>
*
* @param firebaseLink Required. The Firebase link to update.
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final FirebaseLink updateFirebaseLink(FirebaseLink firebaseLink, FieldMask updateMask) {
Expand Down Expand Up @@ -4606,9 +4654,9 @@ public final GoogleAdsLink createGoogleAdsLink(CreateGoogleAdsLinkRequest reques
* }</pre>
*
* @param googleAdsLink The GoogleAdsLink to update
* @param updateMask Required. The list of fields to be updated. Omitted fields will not be
* updated. To replace the entire entity, use one path with the string "&#42;" to match all
* fields.
* @param updateMask Required. The list of fields to be updated. Field names must be in snake case
* (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire
* entity, use one path with the string "&#42;" to match all fields.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final GoogleAdsLink updateGoogleAdsLink(
Expand Down
Expand Up @@ -2871,7 +2871,13 @@ public void updateIosAppDataStream(
*
*
* <pre>
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
* Note that an iOS app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public void createIosAppDataStream(
Expand Down Expand Up @@ -2943,7 +2949,13 @@ public void updateAndroidAppDataStream(
*
*
* <pre>
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
* Note that an Android app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public void createAndroidAppDataStream(
Expand Down Expand Up @@ -4008,7 +4020,13 @@ public void updateIosAppDataStream(
*
*
* <pre>
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
* Note that an iOS app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public void createIosAppDataStream(
Expand Down Expand Up @@ -4095,7 +4113,13 @@ public void updateAndroidAppDataStream(
*
*
* <pre>
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
* Note that an Android app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public void createAndroidAppDataStream(
Expand Down Expand Up @@ -4760,7 +4784,13 @@ public com.google.analytics.admin.v1alpha.IosAppDataStream updateIosAppDataStrea
*
*
* <pre>
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
* Note that an iOS app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public com.google.analytics.admin.v1alpha.IosAppDataStream createIosAppDataStream(
Expand Down Expand Up @@ -4827,7 +4857,13 @@ public com.google.analytics.admin.v1alpha.AndroidAppDataStream updateAndroidAppD
*
*
* <pre>
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
* Note that an Android app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public com.google.analytics.admin.v1alpha.AndroidAppDataStream createAndroidAppDataStream(
Expand Down Expand Up @@ -5485,7 +5521,13 @@ protected AnalyticsAdminServiceFutureStub build(
*
*
* <pre>
* Creates an iOS app data stream with the specified location and attributes.
* Creates an iOS app stream with the specified location and attributes.
* Note that an iOS app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
Expand Down Expand Up @@ -5561,7 +5603,13 @@ protected AnalyticsAdminServiceFutureStub build(
*
*
* <pre>
* Creates an android app stream with the specified location and attributes.
* Creates an Android app stream with the specified location and attributes.
* Note that an Android app stream must be linked to a Firebase app to receive
* traffic.
* To create a working app stream, make sure your property is linked to a
* Firebase project. Then, use the Firebase API to create a Firebase app,
* which will also create an appropriate data stream in Analytics (may take up
* to 24 hours).
* </pre>
*/
public com.google.common.util.concurrent.ListenableFuture<
Expand Down

0 comments on commit e8d6269

Please sign in to comment.