chiu
/
google-api-ruby-client
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Autogenerated update (2020-07-28) 

Update:
- firebase_v1beta1
- fitness_v1
- storagetransfer_v1
- youtube_partner_v1
This commit is contained in:
Google APIs 2020-07-28 00:38:09 +00:00
parent 8868489c35
commit 0982f57d84
8 changed files with 635 additions and 457 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
generated/google/apis/firebase_v1beta1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://firebase.google.com
module FirebaseV1beta1
VERSION = 'V1beta1'
REVISION = '20200720'
REVISION = '20200724'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

411
generated/google/apis/firebase_v1beta1/classes.rb
View File

@ -26,36 +26,33 @@ module Google
class AddFirebaseRequest
include Google::Apis::Core::Hashable
# Deprecated. Instead, to set your project's default GCP resource location,
# Deprecated. Instead, to set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase resources to your project.
# <br>
# <br>The ID of the project's default GCP resource location. The location
# must be one of the available
# [GCP resource
# after you add Firebase resources to the GCP `Project`.
# The ID of the Project's default GCP resource location. The location
# must be one of the available [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The region code (CLDR) that the account will use for Firebase Analytics
# data.
# Deprecated. Instead, to link a Project with a Google Analytics
# account, call
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to the GCP `Project`.
# The region code (CLDR) that the account will use for Google Analytics
# data
# <br>For example: US, GB, or DE
# <br>
# <br>In Java, use `com.google.i18n.identifiers.RegionCode`.
# In Java, use `com.google.i18n.identifiers.RegionCode`.
# Corresponds to the JSON property `regionCode`
# @return [String]
attr_accessor :region_code
# Deprecated. Instead, to link your Project with a Google Analytics account,
# call [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to your Project.
# <br>
# <br>The time zone that the account will use for Firebase Analytics data.
# Deprecated. Instead, to link a Project with a Google Analytics
# account, call
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics)
# after you add Firebase resources to the GCP `Project`.
# The time zone that the account will use for Google Analytics data.
# <br>For example: America/Los_Angeles or Africa/Abidjan
# Corresponds to the JSON property `timeZone`
# @return [String]
@ -79,17 +76,16 @@ module Google
# The ID for the existing
# [Google Analytics account](http://www.google.com/analytics/) that you
# want to link with your `FirebaseProject`.
# <br>
# <br>Specifying this field will provision a new Google Analytics
# want to link with the `FirebaseProject`.
# Specifying this field will provision a new Google Analytics
# property in your Google Analytics account and associate the new property
# with your `FirebaseProject`.
# with the `FirebaseProject`.
# Corresponds to the JSON property `analyticsAccountId`
# @return [String]
attr_accessor :analytics_account_id
# The ID for the existing Google Analytics property that you want to
# associate with your `FirebaseProject`.
# associate with the `FirebaseProject`.
# Corresponds to the JSON property `analyticsPropertyId`
# @return [String]
attr_accessor :analytics_property_id
@ -114,20 +110,22 @@ module Google
# @return [String]
attr_accessor :database_url
# The ID of the project's default GCP resource location. The location is one
# The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# locations](https://firebase.google.com/docs/projects/locations).
# This field is omitted if the default GCP resource location has not been
# finalized yet. To set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# after you add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# Immutable. The globally unique, user-assigned project ID of the parent
# Project.
# Immutable. A user-assigned unique identifier for the `FirebaseProject`.
# This identifier may appear in URLs or names for some Firebase resources
# associated with the Project, but it should generally be treated as a
# convenience alias to reference the Project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@ -159,12 +157,12 @@ module Google
# @return [Google::Apis::FirebaseV1beta1::AnalyticsProperty]
attr_accessor :analytics_property
# For Android Apps and iOS Apps: A map of `app` to `streamId` for each
# <ul>
# <li>For `AndroidApps` and `IosApps`: a map of `app` to `streamId` for each
# Firebase App in the specified `FirebaseProject`. Each `app` and
# `streamId` appears only once.<br>
# <br>
# For Web Apps: A map of `app` to `streamId` and `measurementId` for each
# Firebase App in the specified `FirebaseProject`. Each `app`, `streamId`,
# `streamId` appears only once.
# <li>For `WebApps`: a map of `app` to `streamId` and `measurementId` for
# each `WebApp` in the specified `FirebaseProject`. Each `app`, `streamId`,
# and `measurementId` appears only once.
# Corresponds to the JSON property `streamMappings`
# @return [Array<Google::Apis::FirebaseV1beta1::StreamMapping>]
@ -193,10 +191,9 @@ module Google
# The globally unique, Google-assigned identifier of the Google Analytics
# property associated with the specified `FirebaseProject`.
# <br>
# <br>If you called
# If you called
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) to link
# your `FirebaseProject` with a Google Analytics account, the value in this
# the `FirebaseProject` with a Google Analytics account, the value in this
# `id` field is the same as the ID of the property either specified or
# provisioned with that call to `AddGoogleAnalytics`.
# Corresponds to the JSON property `id`
@ -218,32 +215,45 @@ module Google
class AndroidApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# Immutable. The globally unique, Firebase-assigned identifier for the
# `AndroidApp`.
# This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The user-assigned display name of the App.
# The user-assigned display name for the `AndroidApp`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
# The resource name of the AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App
# (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The canonical package name of the Android App as would appear in the
# Google Play Developer Console.
# Immutable. The canonical package name of the Android app as would appear in
# the Google Play Developer Console.
# Corresponds to the JSON property `packageName`
# @return [String]
attr_accessor :package_name
# The globally unique, user-assigned ID of the parent Project for the App.
# Immutable. A user-assigned unique identifier of the parent
# FirebaseProject for the `AndroidApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@ -272,7 +282,8 @@ module Google
# @return [String]
attr_accessor :config_file_contents
# The filename that the configuration artifact is typically saved as.
# The filename that the configuration artifact for the `AndroidApp` is
# typically saved as.
# <br>For example: `google-services.json`
# Corresponds to the JSON property `configFilename`
# @return [String]
@ -289,13 +300,13 @@ module Google
end
end
# The default resources associated with a `FirebaseProject`.
# The default resources associated with the Project.
class DefaultResources
include Google::Apis::Core::Hashable
# The default Firebase Hosting site name, in the format:
# <br><code><var>projectId</var></code>
# <br>Though rare, your `projectId` might already be used as the name for an
# <code><var>PROJECT_ID</var></code>
# Though rare, your `projectId` might already be used as the name for an
# existing Hosting site in another project (learn more about creating
# non-default,
# [additional sites](https://firebase.google.com/docs/hosting/multisites)).
@ -303,26 +314,26 @@ module Google
# alphanumeric characters to create your default Hosting site name. For
# example, if your `projectId` is `myproject123`, your default Hosting site
# name might be:
# <br><code>myproject123-a5c16</code>
# `myproject123-a5c16`
# Corresponds to the JSON property `hostingSite`
# @return [String]
attr_accessor :hosting_site
# The ID of the project's default GCP resource location. The location is one
# The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# locations](https://firebase.google.com/docs/projects/locations).
# This field is omitted if the default GCP resource location has not been
# finalized yet. To set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# after you add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The default Firebase Realtime Database instance name, in the format:
# <br><code><var>projectId</var></code>
# <br>Though rare, your `projectId` might already be used as the name for an
# <code><var>PROJECT_ID</var></code>
# Though rare, your `projectId` might already be used as the name for an
# existing Realtime Database instance in another project (learn more about
# [database
# sharding](https://firebase.google.com/docs/database/usage/sharding)). In
@ -330,13 +341,13 @@ module Google
# alphanumeric characters to create your default Realtime Database instance
# name. For example, if your `projectId` is `myproject123`, your default
# database instance name might be:
# <br><code>myproject123-a5c16</code>
# `myproject123-a5c16`
# Corresponds to the JSON property `realtimeDatabaseInstance`
# @return [String]
attr_accessor :realtime_database_instance
# The default Cloud Storage for Firebase storage bucket, in the format:
# <br><code><var>projectId</var>.appspot.com</code>
# <code><var>PROJECT_ID</var>.appspot.com</code>
# Corresponds to the JSON property `storageBucket`
# @return [String]
attr_accessor :storage_bucket
@ -377,9 +388,8 @@ module Google
class FinalizeDefaultLocationRequest
include Google::Apis::Core::Hashable
# The ID of the default GCP resource location for the Project. The location
# must be one of the available
# [GCP resource
# The ID of the Project's default GCP resource location. The location must be
# one of the available [GCP resource
# locations](https://firebase.google.com/docs/projects/locations).
# Corresponds to the JSON property `locationId`
# @return [String]
@ -399,9 +409,9 @@ module Google
class FirebaseAppInfo
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# Immutable. The globally unique, Firebase-assigned identifier for the
# `WebApp`.
# This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
@ -412,10 +422,12 @@ module Google
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the Firebase App, in the format:
# <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# or <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var>
# </code>
# The resource name of the Firebase App, in the format:
# <code>projects/<var>PROJECT_ID</var>/iosApps/<var>APP_ID</var></code>
# or
# <code>projects/<var>PROJECT_ID</var>/androidApps/<var>APP_ID</var></code>
# or
# <code>projects/<var>PROJECT_ID</var>/webApps/<var>APP_ID</var></code>
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
@ -440,21 +452,18 @@ module Google
# A `FirebaseProject` is the top-level Firebase entity. It is the container for
# Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime
# Database, Cloud Firestore, Cloud Storage buckets) and other Firebase and
# Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and
# Google Cloud Platform (GCP) resources.
# <br>
# <br>You can create a new `FirebaseProject` in the
# [Firebase console](https://console.firebase.google.com/),
# or you can add Firebase resources to an existing
# You create a `FirebaseProject` by calling
# AddFirebase
# and specifying an *existing*
# [GCP
# `Project`](https://cloud.google.com/resource-manager/reference/rest/v1/
# projects)
# by calling
# AddFirebase.
# <br>
# <br>A `FirebaseProject` is actually also a GCP `Project`, so a
# `FirebaseProject` uses underlying GCP identifiers (most importantly,
# `projectId`) as its own for easy interop with GCP APIs.
# projects).
# This adds Firebase resources to the existing GCP `Project`.
# Since a FirebaseProject is actually also a GCP `Project`, a
# `FirebaseProject` has the same underlying GCP identifiers (`projectNumber`
# and `projectId`). This allows for easy interop with Google APIs.
class FirebaseProject
include Google::Apis::Core::Hashable
@ -463,23 +472,37 @@ module Google
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the Project, in the format:
# <br><code>projects/<var>projectId</var></code>
# The resource name of the Project, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# <var>PROJECT_IDENTIFIER</var>: the Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# <br>Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# Immutable. The globally unique, user-assigned ID of the Project.
# Immutable. A user-assigned unique identifier for the Project.
# This identifier may appear in URLs or names for some Firebase resources
# associated with the Project, but it should generally be treated as a
# convenience alias to reference the Project.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
# The globally unique, Google-assigned identifier of the Project.
# Immutable. The globally unique, Google-assigned canonical identifier for
# the Project.
# Use this identifier when configuring integrations and/or
# making API calls to Firebase or third-party services.
# Corresponds to the JSON property `projectNumber`
# @return [Fixnum]
attr_accessor :project_number
# The default resources associated with a `FirebaseProject`.
# The default resources associated with the Project.
# Corresponds to the JSON property `resources`
# @return [Google::Apis::FirebaseV1beta1::DefaultResources]
attr_accessor :resources
@ -502,38 +525,49 @@ module Google
class IosApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# Immutable. The globally unique, Firebase-assigned identifier for the
# `IosApp`.
# This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The automatically generated Apple ID assigned to the App by Apple in the
# iOS App Store.
# The automatically generated Apple ID assigned to the iOS app by Apple in
# the iOS App Store.
# Corresponds to the JSON property `appStoreId`
# @return [String]
attr_accessor :app_store_id
# The canonical bundle ID of the iOS App as it would appear in the iOS
# AppStore.
# Immutable. The canonical bundle ID of the iOS app as it would appear in the
# iOS AppStore.
# Corresponds to the JSON property `bundleId`
# @return [String]
attr_accessor :bundle_id
# The user-assigned display name of the App.
# The user-assigned display name for the `IosApp`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# The resource name of the IosApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The globally unique, user-assigned ID of the parent Project for the App.
# Immutable. A user-assigned unique identifier of the parent
# FirebaseProject for the `IosApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@ -563,7 +597,8 @@ module Google
# @return [String]
attr_accessor :config_file_contents
# The filename that the configuration artifact is typically saved as.
# The filename that the configuration artifact for the `IosApp` is typically
# saved as.
# <br>For example: `GoogleService-Info.plist`
# Corresponds to the JSON property `configFilename`
# @return [String]
@ -584,7 +619,7 @@ module Google
class ListAndroidAppsResponse
include Google::Apis::Core::Hashable
# List of each AndroidApp that is in the parent Firebase Project.
# List of each `AndroidApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::AndroidApp>]
attr_accessor :apps
@ -592,11 +627,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListAndroidApps` to
# This token can be used in a subsequent call to `ListAndroidApps` to
# find the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -624,11 +657,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results and all available locations have been listed.
# <br>
# <br>This token can be used in a subsequent call to
# This token can be used in a subsequent call to
# `ListAvailableLocations` to find more locations.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -651,11 +682,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent calls to `ListAvailableProjects`
# to find the next group of GCP `Projects`.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# This token can be used in a subsequent calls to `ListAvailableProjects`
# to find the next group of Projects.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -683,11 +712,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent calls to `ListFirebaseProjects`
# This token can be used in a subsequent calls to `ListFirebaseProjects`
# to find the next group of Projects.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -712,7 +739,7 @@ module Google
class ListIosAppsResponse
include Google::Apis::Core::Hashable
# List of each IosApp that is in the parent Firebase Project.
# List of each `IosApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::IosApp>]
attr_accessor :apps
@ -720,11 +747,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListIosApps` to find
# This token can be used in a subsequent call to `ListIosApps` to find
# the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -744,7 +769,7 @@ module Google
class ListShaCertificatesResponse
include Google::Apis::Core::Hashable
# The list of SHA certificates associated with the App.
# The list of each `ShaCertificate` associated with the `AndroidApp`.
# Corresponds to the JSON property `certificates`
# @return [Array<Google::Apis::FirebaseV1beta1::ShaCertificate>]
attr_accessor :certificates
@ -763,7 +788,7 @@ module Google
class ListWebAppsResponse
include Google::Apis::Core::Hashable
# List of each WebApp that is in the parent Firebase Project.
# List of each `WebApp` associated with the specified `FirebaseProject`.
# Corresponds to the JSON property `apps`
# @return [Array<Google::Apis::FirebaseV1beta1::WebApp>]
attr_accessor :apps
@ -771,11 +796,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned. If the string is empty, then this response is the last page of
# results.
# <br>
# <br>This token can be used in a subsequent call to `ListWebApps` to find
# This token can be used in a subsequent call to `ListWebApps` to find
# the next group of Apps.
# <br>
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -791,7 +814,7 @@ module Google
end
end
# A GCP resource location that can be selected for a Project.
# A GCP resource location that can be selected for a FirebaseProject.
class Location
include Google::Apis::Core::Hashable
@ -908,28 +931,30 @@ module Google
class ProjectInfo
include Google::Apis::Core::Hashable
# The user-assigned display name of the GCP `Project`, for example:
# <code>My App</code>
# The user-assigned display name of the GCP `Project`, for example: `My App`
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The ID of the project's default GCP resource location. The location is one
# The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br> <br>
# Not all projects will have this field populated. If it is not populated, it
# means that the project does not yet have a default GCP resource location.
# To set your project's default GCP resource location, call
# locations](https://firebase.google.com/docs/projects/locations).
# Not all Projects will have this field populated. If it is not populated, it
# means that the Project does not yet have a default GCP resource location.
# To set a Project's default GCP resource location, call
# [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize) after you
# add Firebase resources to your project.
# add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
# The resource name of the GCP `Project` to which Firebase resources can be
# added, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# Corresponds to the JSON property `project`
# @return [String]
attr_accessor :project
@ -954,10 +979,12 @@ module Google
# specified `FirebaseProject`.
# <ul>
# <li>If not set, then the Google Analytics property that is currently
# associated with the specified `FirebaseProject` is removed.</li>
# associated with the specified `FirebaseProject` is removed.
# </li>
# <li>If set, and the specified `FirebaseProject` is currently associated
# with a <em>different</em> Google Analytics property, then the response is a
# `412 Precondition Failed` error.</li>
# with a *different* Google Analytics property, then the response
# is a `412 Precondition Failed` error.
# </li>
# </ul>
# Corresponds to the JSON property `analyticsPropertyId`
# @return [String]
@ -984,11 +1011,9 @@ module Google
# If the result list is too large to fit in a single response, then a token
# is returned.
# <br>
# <br>This token can be used in a subsequent calls to `SearchFirebaseApps`
# This token can be used in a subsequent calls to `SearchFirebaseApps`
# to find the next group of Apps.
# <br>If the string is empty, then this response is the last page of results.
# <br>Page tokens are short-lived and should not be persisted.
# Page tokens are short-lived and should not be persisted.
# Corresponds to the JSON property `nextPageToken`
# @return [String]
attr_accessor :next_page_token
@ -1008,19 +1033,33 @@ module Google
class ShaCertificate
include Google::Apis::Core::Hashable
# The SHA certificate type.
# The type of SHA certificate encoded in the hash.
# Corresponds to the JSON property `certType`
# @return [String]
attr_accessor :cert_type
# The fully qualified resource name of the `sha-key`, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var>/sha/
# <var>SHA_ID</var></code>
# The resource name of the ShaCertificate for the AndroidApp,
# in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var>/sha/
# <var>SHA_HASH</var></code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App
# (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
# * <var>SHA_HASH</var>: the certificate hash for the App (see
# [`shaHash`](../projects.androidApps.sha#ShaCertificate.FIELDS.sha_hash)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The certificate hash for the App.
# The certificate hash for the `AndroidApp`.
# Corresponds to the JSON property `shaHash`
# @return [String]
attr_accessor :sha_hash
@ -1142,24 +1181,26 @@ module Google
class StreamMapping
include Google::Apis::Core::Hashable
# The fully qualified resource name of the Firebase App associated with the
# The resource name of the Firebase App associated with the
# Google Analytics data stream, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# or
# <code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var></code>
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code>
# or
# <code>projects/<var>PROJECT_NUMBER</var>/webApps/<var>APP_ID</var></code>
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# Corresponds to the JSON property `app`
# @return [String]
attr_accessor :app
# Applicable for Firebase Web Apps only.<br>
# <br>The unique Google-assigned identifier of the Google Analytics web
# Applicable for Firebase Web Apps only.
# The unique Google-assigned identifier of the Google Analytics web
# stream associated with the Firebase Web App. Firebase SDKs use this ID to
# interact with Google Analytics APIs.
# <br>
# <br>Learn more about this ID and Google Analytics web streams in the
# Learn more about this ID and Google Analytics web streams in the
# [Analytics
# documentation](https://support.google.com/analytics/topic/9303475).
# Corresponds to the JSON property `measurementId`
@ -1168,8 +1209,7 @@ module Google
# The unique Google-assigned identifier of the Google Analytics data stream
# associated with the Firebase App.
# <br>
# <br>Learn more about Google Analytics data streams in the
# Learn more about Google Analytics data streams in the
# [Analytics
# documentation](https://support.google.com/analytics/answer/9303323).
# Corresponds to the JSON property `streamId`
@ -1228,31 +1268,42 @@ module Google
class WebApp
include Google::Apis::Core::Hashable
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# <br>
# <br>This identifier should be treated as an opaque token, as the data
# Immutable. The globally unique, Firebase-assigned identifier for the
# `WebApp`.
# This identifier should be treated as an opaque token, as the data
# format is not specified.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The fully qualified URLs where the App is hosted.
# The URLs where the `WebApp` is hosted.
# Corresponds to the JSON property `appUrls`
# @return [Array<String>]
attr_accessor :app_urls
# The user-assigned display name of the App.
# The user-assigned display name for the `WebApp`.
# Corresponds to the JSON property `displayName`
# @return [String]
attr_accessor :display_name
# The fully qualified resource name of the App, for example:
# <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code>
# The resource name of the WebApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
# Corresponds to the JSON property `name`
# @return [String]
attr_accessor :name
# The globally unique, user-assigned ID of the parent Project for the App.
# Immutable. A user-assigned unique identifier of the parent
# FirebaseProject for the `WebApp`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id
@ -1275,18 +1326,19 @@ module Google
class WebAppConfig
include Google::Apis::Core::Hashable
# The API key associated with the web App.
# The API key associated with the `WebApp`.
# Corresponds to the JSON property `apiKey`
# @return [String]
attr_accessor :api_key
# Immutable. The globally unique, Firebase-assigned identifier of the App.
# Immutable. The globally unique, Firebase-assigned identifier for the
# `WebApp`.
# Corresponds to the JSON property `appId`
# @return [String]
attr_accessor :app_id
# The domain Firebase Auth configures for OAuth redirects, in the format:
# <br><code><var>projectId</var>.firebaseapp.com</code>
# <code><var>PROJECT_ID</var>.firebaseapp.com</code>
# Corresponds to the JSON property `authDomain`
# @return [String]
attr_accessor :auth_domain
@ -1296,14 +1348,14 @@ module Google
# @return [String]
attr_accessor :database_url
# The ID of the project's default GCP resource location. The location is one
# The ID of the Project's default GCP resource location. The location is one
# of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>This field is omitted if the default GCP resource location has not been
# finalized yet. To set your project's default GCP resource location,
# locations](https://firebase.google.com/docs/projects/locations).
# This field is omitted if the default GCP resource location has not been
# finalized yet. To set a Project's default GCP resource location,
# call [`FinalizeDefaultLocation`](../projects.defaultLocation/finalize)
# after you add Firebase services to your project.
# after you add Firebase resources to the Project.
# Corresponds to the JSON property `locationId`
# @return [String]
attr_accessor :location_id
@ -1319,8 +1371,7 @@ module Google
# @return [String]
attr_accessor :messaging_sender_id
# Immutable. The globally unique, user-assigned project ID of the parent
# Project for the App.
# Immutable. A user-assigned unique identifier for the `FirebaseProject`.
# Corresponds to the JSON property `projectId`
# @return [String]
attr_accessor :project_id

611
generated/google/apis/firebase_v1beta1/service.rb
View File

@ -48,30 +48,30 @@ module Google
@batch_path = 'batch'
end
# Returns a list of [Google Cloud Platform (GCP) `Projects`]
# Lists each [Google Cloud Platform (GCP) `Project`]
# (https://cloud.google.com/resource-manager/reference/rest/v1/projects)
# that are available to have Firebase resources added to them.
# <br>
# <br>A GCP `Project` will only be returned if:
# <ol>
# <li><p>The caller has sufficient
# that can have Firebase resources added to it.
# A Project will only be listed if:
# <ul>
# <li>The caller has sufficient
# [Google IAM](https://cloud.google.com/iam) permissions to call
# AddFirebase.</p></li>
# <li><p>The GCP `Project` is not already a FirebaseProject.</p></li>
# <li><p>The GCP `Project` is not in an Organization which has policies
# that prevent Firebase resources from being added.</p></li>
# </ol>
# AddFirebase.
# </li>
# <li>The Project is not already a FirebaseProject.
# </li>
# <li>The Project is not in an Organization which has policies
# that prevent Firebase resources from being added.
# </li>
# </ul>
# @param [Fixnum] page_size
# The maximum number of GCP `Projects` to return in the response.
# <br>
# <br>The server may return fewer than this value at its discretion.
# The maximum number of Projects to return in the response.
# The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
# <br>
# <br>This value cannot be negative.
# This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListAvailableProjects`
# indicating where in the set of GCP `Projects` to resume listing.
# indicating where in the set of Projects to resume listing.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -135,12 +135,10 @@ module Google
# Adds Firebase resources to the specified existing
# [Google Cloud Platform (GCP) `Project`]
# (https://cloud.google.com/resource-manager/reference/rest/v1/projects).
# <br>
# <br>Since a FirebaseProject is actually also a GCP `Project`, a
# `FirebaseProject` uses underlying GCP identifiers (most importantly,
# the `PROJECT_NUMBER`) as its own for easy interop with GCP APIs.
# <br>
# <br>The result of this call is an [`Operation`](../../v1beta1/operations).
# Since a FirebaseProject is actually also a GCP `Project`, a
# `FirebaseProject` has the same underlying GCP identifiers (`projectNumber`
# and `projectId`). This allows for easy interop with Google APIs.
# The result of this call is an [`Operation`](../../v1beta1/operations).
# Poll the `Operation` to track the provisioning process by calling
# GetOperation until
# [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When
@ -152,11 +150,9 @@ module Google
# google.rpc.Status. The `Operation` is automatically deleted after
# completion, so there is no need to call
# DeleteOperation.
# <br>
# <br>This method does not modify any billing account information on the
# This method does not modify any billing account information on the
# underlying GCP `Project`.
# <br>
# <br>To call `AddFirebase`, a project member or service account must have
# To call `AddFirebase`, a project member or service account must have
# the following permissions (the IAM roles of Editor and Owner contain these
# permissions):
# `firebase.projects.update`, `resourcemanager.projects.get`,
@ -164,11 +160,18 @@ module Google
# @param [String] project
# The resource name of the GCP `Project` to which Firebase resources will be
# added, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# After calling `AddFirebase`, the
# [`project_id`](https://cloud.google.com/resource-manager/reference/rest/v1/
# projects#Project.FIELDS.project_id)
# of the GCP `Project` is also the `project_id` of the FirebaseProject.
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# After calling `AddFirebase`, the unique Project identifiers (
# [`projectNumber`](https://cloud.google.com/resource-manager/reference/rest/v1/
# projects#Project.FIELDS.project_number)
# and
# [`projectId`](https://cloud.google.com/resource-manager/reference/rest/v1/
# projects#Project.FIELDS.project_id))
# of the underlying GCP `Project` are also the identifiers of the
# FirebaseProject.
# @param [Google::Apis::FirebaseV1beta1::AddFirebaseRequest] add_firebase_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -199,38 +202,35 @@ module Google
execute_or_queue_command(command, &block)
end
# Links a FirebaseProject with an existing
# Links the specified FirebaseProject with an existing
# [Google Analytics account](http://www.google.com/analytics/).
# <br>
# <br>Using this call, you can either:
# Using this call, you can either:
# <ul>
# <li>Specify an `analyticsAccountId` to provision a new Google Analytics
# property within the specified account and associate the new property with
# your `FirebaseProject`.</li>
# the `FirebaseProject`.
# <li>Specify an existing `analyticsPropertyId` to associate the property
# with your `FirebaseProject`.</li>
# with the `FirebaseProject`.
# </ul>
# <br>
# Note that when you call `AddGoogleAnalytics`:
# <ol>
# <li>The first check determines if any existing data streams in the
# Google Analytics property correspond to any existing Firebase Apps in your
# `FirebaseProject` (based on the `packageName` or `bundleId` associated with
# the data stream). Then, as applicable, the data streams and apps are
# linked. Note that this auto-linking only applies to Android Apps and iOS
# Apps.</li>
# <li>If no corresponding data streams are found for your Firebase Apps,
# new data streams are provisioned in the Google Analytics property
# for each of your Firebase Apps. Note that a new data stream is always
# provisioned for a Web App even if it was previously associated with a
# data stream in your Analytics property.</li>
# Google Analytics property correspond to any existing Firebase Apps in the
# `FirebaseProject` (based on the `packageName` or `bundleId` associated
# with the data stream). Then, as applicable, the data streams and apps are
# linked. Note that this auto-linking only applies to `AndroidApps` and
# `IosApps`.
# <li>If no corresponding data streams are found for the Firebase Apps, new
# data streams are provisioned in the Google Analytics property for each of
# the Firebase Apps. Note that a new data stream is always provisioned for
# a Web App even if it was previously associated with a data stream in the
# Analytics property.
# </ol>
# Learn more about the hierarchy and structure of Google Analytics
# accounts in the
# [Analytics
# documentation](https://support.google.com/analytics/answer/9303323).
# <br>
# <br>The result of this call is an [`Operation`](../../v1beta1/operations).
# The result of this call is an [`Operation`](../../v1beta1/operations).
# Poll the `Operation` to track the provisioning process by calling
# GetOperation until
# [`done`](../../v1beta1/operations#Operation.FIELDS.done) is `true`. When
@ -240,22 +240,23 @@ module Google
# an AnalyticsDetails; if the `Operation` failed, its
# [`error`](../../v1beta1/operations#Operation.FIELDS.error) is set to a
# google.rpc.Status.
# <br>
# <br>To call `AddGoogleAnalytics`, a member must be an Owner for
# To call `AddGoogleAnalytics`, a project member must be an Owner for
# the existing `FirebaseProject` and have the
# [`Edit` permission](https://support.google.com/analytics/answer/2884495)
# for the Google Analytics account.
# <br>
# <br>If a `FirebaseProject` already has Google Analytics enabled, and you
# If the `FirebaseProject` already has Google Analytics enabled, and you
# call `AddGoogleAnalytics` using an `analyticsPropertyId` that's different
# from the currently associated property, then the call will fail. Analytics
# may have already been enabled in the Firebase console or by specifying
# `timeZone` and `regionCode` in the call to
# [`AddFirebase`](../../v1beta1/projects/addFirebase).
# @param [String] parent
# The parent `FirebaseProject` to link to an existing Google Analytics
# account, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the FirebaseProject to link to an existing Google
# Analytics account, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest] add_google_analytics_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -286,10 +287,13 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the FirebaseProject identified by the specified resource name.
# Gets the specified FirebaseProject.
# @param [String] name
# The fully qualified resource name of the Project, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the FirebaseProject, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -317,15 +321,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the configuration artifact used by servers to simplify initialization.
# <br>
# <br>Typically, this configuration is used with the Firebase Admin SDK
# Gets the configuration artifact associated with the specified
# FirebaseProject, which can be used by servers to simplify
# initialization.
# Typically, this configuration is used with the Firebase Admin SDK
# [initializeApp](https://firebase.google.com/docs/admin/setup#
# initialize_the_sdk)
# command.
# @param [String] name
# The fully qualified resource name of the Project, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/adminSdkConfig</code>
# The resource name of the FirebaseProject, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/adminSdkConfig</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -353,14 +361,16 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the Google Analytics details currently associated with a
# Gets the Google Analytics details currently associated with the specified
# FirebaseProject.
# <br>
# <br>If the `FirebaseProject` is not yet linked to Google Analytics, then
# the response to `GetAnalyticsDetails` is NOT_FOUND.
# If the `FirebaseProject` is not yet linked to Google Analytics, then
# the response to `GetAnalyticsDetails` is `NOT_FOUND`.
# @param [String] name
# The fully qualified resource name, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/analyticsDetails</code>
# The resource name of the FirebaseProject, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/analyticsDetails</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -389,27 +399,22 @@ module Google
end
# Lists each FirebaseProject accessible to the caller.
# <br>
# <br>The elements are returned in no particular order, but they will be a
# The elements are returned in no particular order, but they will be a
# consistent view of the Projects when additional requests are made with a
# `pageToken`.
# <br>
# <br>This method is eventually consistent with Project mutations, which
# This method is eventually consistent with Project mutations, which
# means newly provisioned Projects and recent modifications to existing
# Projects might not be reflected in the set of Projects. The list will
# include only ACTIVE Projects.
# <br>
# <br>Use
# Use
# GetFirebaseProject
# for consistent reads as well as for additional Project details.
# @param [Fixnum] page_size
# The maximum number of Projects to return in the response.
# <br>
# <br>The server may return fewer than this at its discretion.
# The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
# <br>
# <br>This value cannot be negative.
# This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListFirebaseProjects` indicating
# where in the set of Projects to resume listing.
@ -441,19 +446,24 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the FirebaseProject identified by the
# specified resource name.
# <br>
# <br>All [query parameters](#query-parameters) are required.
# Updates the attributes of the specified FirebaseProject.
# All [query parameters](#query-parameters) are required.
# @param [String] name
# The fully qualified resource name of the Project, in the format:
# <br><code>projects/<var>projectId</var></code>
# The resource name of the Project, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# <var>PROJECT_IDENTIFIER</var>: the Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# <br>Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# @param [Google::Apis::FirebaseV1beta1::FirebaseProject] firebase_project_object
# @param [String] update_mask
# Specifies which fields to update.
# <br>
# <br>If this list is empty, then no state will be updated.
# <br>Note that the fields `name`, `project_id`, and `project_number` are all
# If this list is empty, then no state will be updated.
# Note that the fields `name`, `projectId`, and `projectNumber` are all
# immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -485,27 +495,27 @@ module Google
execute_or_queue_command(command, &block)
end
# Unlinks the specified `FirebaseProject` from its Google Analytics account.
# <br>
# <br>This call removes the association of the specified `FirebaseProject`
# Unlinks the specified FirebaseProject from its Google Analytics
# account.
# This call removes the association of the specified `FirebaseProject`
# with its current Google Analytics property. However, this call does not
# delete the Google Analytics resources, such as the Google Analytics
# property or any data streams.
# <br>
# <br>These resources may be re-associated later to the `FirebaseProject` by
# These resources may be re-associated later to the `FirebaseProject` by
# calling
# [`AddGoogleAnalytics`](../../v1beta1/projects/addGoogleAnalytics) and
# specifying the same `analyticsPropertyId`. For Android Apps and iOS Apps,
# this call re-links data streams with their corresponding apps. However,
# for Web Apps, this call provisions a <em>new</em> data stream for each Web
# App.
# <br>
# <br>To call `RemoveAnalytics`, a member must be an Owner for
# for Web Apps, this call provisions a *new* data stream for each Web App.
# To call `RemoveAnalytics`, a project member must be an Owner for
# the `FirebaseProject`.
# @param [String] parent
# The parent `FirebaseProject` to unlink from its Google Analytics account,
# in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the FirebaseProject to unlink from its Google
# Analytics account, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest] remove_analytics_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -536,23 +546,22 @@ module Google
execute_or_queue_command(command, &block)
end
# A convenience method that lists all available Apps for the specified
# FirebaseProject.
# <br>
# <br>Typically, interaction with an App should be done using the
# platform-specific service, but some tool use-cases require a summary of all
# known Apps (such as for App selector interfaces).
# Lists all available Apps for the specified FirebaseProject.
# This is a convenience method. Typically, interaction with an App should
# be done using the platform-specific service, but some tool use-cases
# require a summary of all known Apps (such as for App selector interfaces).
# @param [String] parent
# The parent Project for which to list Apps, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The parent FirebaseProject for which to list Apps, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
# <br>
# <br>The server may return fewer than this value at its discretion.
# The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# <br>
# <br>This value cannot be negative.
# This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `SearchFirebaseApps` indicating
# where in the set of Apps to resume listing.
@ -585,14 +594,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Requests that a new AndroidApp be created.
# <br>
# <br>The result of this call is an `Operation` which can be used to track
# Requests the creation of a new AndroidApp in the specified
# FirebaseProject.
# The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
# The parent Project in which to create an App, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject in which to create an
# AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -623,14 +636,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the AndroidApp identified by the specified resource name.
# Gets the specified AndroidApp.
# @param [String] name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></
# The resource name of the AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/androidApps/<var>APP_ID</var></code>
# <code>projects/-/androidApps/<var>APP_ID</var></code>
# <br>
# Refer to the `AndroidApp`
# [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -661,12 +679,18 @@ module Google
# Gets the configuration artifact associated with the specified
# AndroidApp.
# @param [String] name
# The resource name of the App configuration to download, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var>/
# The resource name of the AndroidApp configuration to download, in the
# format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var>/
# config</code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/androidApps/<var>APP_ID</var></code>
# <code>projects/-/androidApps/<var>APP_ID</var></code>
# <br>
# Refer to the `AndroidApp`
# [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -694,18 +718,21 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists each AndroidApp associated with the specified parent Project.
# <br>
# <br>The elements are returned in no particular order, but will be a
# Lists each AndroidApp associated with the specified
# FirebaseProject.
# The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
# The parent Project for which to list Apps, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject for which to list each
# associated AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
# <br>
# <br>The server may return fewer than this at its discretion.
# The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# @param [String] page_token
@ -740,15 +767,26 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the AndroidApp identified by the specified
# resource name.
# Updates the attributes of the specified AndroidApp.
# @param [String] name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/androidApps/<var>appId</var></code>
# The resource name of the AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App
# (see [`appId`](../projects.androidApps#AndroidApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::AndroidApp] android_app_object
# @param [String] update_mask
# Specifies which fields to update.
# <br>Note that the fields `name`, `app_id`, `project_id`, and `package_name`
# Note that the fields `name`, `app_id`, `project_id`, and `package_name`
# are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -780,14 +818,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Adds a SHA certificate to the specified AndroidApp.
# Adds a ShaCertificate to the specified AndroidApp.
# @param [String] parent
# The parent App to which a SHA certificate will be added, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></
# The resource name of the parent AndroidApp to which to add a
# ShaCertificate, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/androidApps/<var>APP_ID</var></code>
# <code>projects/-/androidApps/<var>APP_ID</var></code>
# <br>
# Refer to the `AndroidApp`
# [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [Google::Apis::FirebaseV1beta1::ShaCertificate] sha_certificate_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -818,14 +862,19 @@ module Google
execute_or_queue_command(command, &block)
end
# Removes a SHA certificate from the specified AndroidApp.
# Removes a ShaCertificate from the specified AndroidApp.
# @param [String] name
# The fully qualified resource name of the `sha-key`, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var>/sha/
# <var>SHA_ID</var></code>
# <br>You can obtain the full name from the response of
# [`ListShaCertificates`](../projects.androidApps.sha/list) or the original
# [`CreateShaCertificate`](../projects.androidApps.sha/create).
# The resource name of the ShaCertificate to remove from the parent
# AndroidApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var>/sha/
# <var>SHA_HASH</var></code>
# Refer to the `ShaCertificate`
# [`name`](../projects.androidApps.sha#ShaCertificate.FIELDS.name) field for
# details about <var>PROJECT_IDENTIFIER</var>, <var>APP_ID</var>, and
# <var>SHA_HASH</var> values.
# You can obtain the full resource name of the `ShaCertificate` from the
# response of [`ListShaCertificates`](../projects.androidApps.sha/list) or
# the original [`CreateShaCertificate`](../projects.androidApps.sha/create).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -853,15 +902,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns the list of SHA-1 and SHA-256 certificates for the specified
# AndroidApp.
# Lists the SHA-1 and SHA-256 certificates for the specified AndroidApp.
# @param [String] parent
# The parent App for which to list SHA certificates, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/androidApps/<var>APP_ID</var></
# The resource name of the parent AndroidApp for which to list each
# associated ShaCertificate, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/androidApps/<var>APP_ID</var></
# code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/androidApps/<var>APP_ID</var></code>
# <code>projects/-/androidApps/<var>APP_ID</var></code>
# <br>
# Refer to the `AndroidApp`
# [`name`](../projects.androidApps#AndroidApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -889,41 +943,42 @@ module Google
execute_or_queue_command(command, &block)
end
# Returns a list of valid Google Cloud Platform (GCP) resource locations for
# Lists the valid Google Cloud Platform (GCP) resource locations for
# the specified Project (including a FirebaseProject).
# <br>
# <br>One of these locations can be selected as the Project's [_default_ GCP
# One of these locations can be selected as the Project's [_default_ GCP
# resource location](https://firebase.google.com/docs/projects/locations),
# which is the geographical location where project resources, such as Cloud
# Firestore, will be provisioned by default. However, if the default GCP
# resource location has already been set for the Project, then this setting
# cannot be changed.
# <br>
# <br>This call checks for any possible
# which is the geographical location where the Project's resources, such as
# Cloud Firestore, will be provisioned by default. However, if the default
# GCP resource location has already been set for the Project, then this
# setting cannot be changed.
# This call checks for any possible
# [location
# restrictions](https://cloud.google.com/resource-manager/docs/organization-
# policy/defining-locations)
# for the specified Project and, thus, might return a subset of all possible
# GCP resource locations. To list all GCP resource locations (regardless of
# any restrictions), call the endpoint without specifying a `PROJECT_NUMBER`
# (that is, `/v1beta1/`parent=projects/-`/listAvailableLocations`). <br>
# <br>To call `ListAvailableLocations` with a specified project, a member
# must be at minimum a Viewer of the project. Calls without a specified
# project do not require any specific project permissions.
# any restrictions), call the endpoint without specifying a unique project
# identifier (that is,
# `/v1beta1/`parent=projects/-`/listAvailableLocations`).
# To call `ListAvailableLocations` with a specified project, a member must be
# at minimum a Viewer of the Project. Calls without a specified project do
# not require any specific project permissions.
# @param [String] parent
# The Project for which to list GCP resource locations, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# <br>If no project is specified (that is, `projects/-`), the returned list
# does not take into account org-specific or project-specific location
# restrictions.
# The FirebaseProject for which to list GCP resource locations,
# in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# If no unique project identifier is specified (that is, `projects/-`),
# the returned list does not take into account org-specific or
# project-specific location restrictions.
# @param [Fixnum] page_size
# The maximum number of locations to return in the response.
# <br>
# <br>The server may return fewer than this value at its discretion.
# The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# <br>
# <br>This value cannot be negative.
# This value cannot be negative.
# @param [String] page_token
# Token returned from a previous call to `ListAvailableLocations` indicating
# where in the list of locations to resume listing.
@ -958,31 +1013,28 @@ module Google
# Sets the default Google Cloud Platform (GCP) resource location for the
# specified FirebaseProject.
# <br>
# <br>This method creates an App Engine application with a
# This method creates an App Engine application with a
# [default Cloud Storage
# bucket](https://cloud.google.com/appengine/docs/standard/python/
# googlecloudstorageclient/setting-up-cloud-storage#
# activating_a_cloud_storage_bucket),
# located in the specified
# [`location_id`](#body.request_body.FIELDS.location_id).
# [`locationId`](#body.request_body.FIELDS.location_id).
# This location must be one of the available
# [GCP resource
# locations](https://firebase.google.com/docs/projects/locations). <br>
# <br>After the default GCP resource location is finalized, or if it was
# locations](https://firebase.google.com/docs/projects/locations).
# After the default GCP resource location is finalized, or if it was
# already set, it cannot be changed. The default GCP resource location for
# the specified FirebaseProject might already be set because either the
# GCP `Project` already has an App Engine application or
# the specified `FirebaseProject` might already be set because either the
# underlying GCP `Project` already has an App Engine application or
# `FinalizeDefaultLocation` was previously called with a specified
# `location_id`. Any new calls to `FinalizeDefaultLocation` with a
# <em>different</em> specified `location_id` will return a 409 error.
# <br>
# <br>The result of this call is an [`Operation`](../../v1beta1/operations),
# `locationId`. Any new calls to `FinalizeDefaultLocation` with a
# *different* specified `locationId` will return a 409 error.
# The result of this call is an [`Operation`](../../v1beta1/operations),
# which can be used to track the provisioning process. The
# [`response`](../../v1beta1/operations#Operation.FIELDS.response) type of
# the `Operation` is google.protobuf.Empty.
# <br>
# <br>The `Operation` can be polled by its `name` using
# The `Operation` can be polled by its `name` using
# GetOperation until `done` is
# true. When `done` is true, the `Operation` has either succeeded or failed.
# If the `Operation` has succeeded, its
@ -991,15 +1043,16 @@ module Google
# `error` will be set to a google.rpc.Status. The `Operation` is
# automatically deleted after completion, so there is no need to call
# DeleteOperation.
# <br>
# <br>All fields listed in the [request body](#request-body) are required.
# <br>
# <br>To call `FinalizeDefaultLocation`, a member must be an Owner
# of the project.
# All fields listed in the [request body](#request-body) are required.
# To call `FinalizeDefaultLocation`, a member must be an Owner
# of the Project.
# @param [String] parent
# The resource name of the Project for which the default GCP resource
# location will be set, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the FirebaseProject for which the default GCP
# resource location will be set, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var></code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest] finalize_default_location_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1030,14 +1083,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Requests that a new IosApp be created.
# <br>
# <br>The result of this call is an `Operation` which can be used to track
# Requests the creation of a new IosApp in the specified
# FirebaseProject.
# The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
# The parent Project in which to create an App, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject in which to create an
# IosApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1068,13 +1125,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the IosApp identified by the specified resource name.
# Gets the specified IosApp.
# @param [String] name
# The fully qualified resource name of the App, in the format:
# <code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var></code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# The resource name of the IosApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code>
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/iosApps/<var>APP_ID</var></code>
# <code>projects/-/iosApps/<var>APP_ID</var></code>
# <br>
# Refer to the `IosApp`
# [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1105,11 +1167,16 @@ module Google
# Gets the configuration artifact associated with the specified IosApp.
# @param [String] name
# The resource name of the App configuration to download, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/iosApps/<var>APP_ID</var>/config</
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var>/config</
# code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/iosApps/<var>APP_ID</var></code>
# <code>projects/-/iosApps/<var>APP_ID</var></code>
# <br>
# Refer to the `IosApp`
# [`name`](../projects.iosApps#IosApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1137,18 +1204,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists each IosApp associated with the specified parent Project.
# <br>
# <br>The elements are returned in no particular order, but will be a
# Lists each IosApp associated with the specified FirebaseProject.
# The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
# The parent Project for which to list Apps, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject for which to list each
# associated IosApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
# <br>
# <br>The server may return fewer than this at its discretion.
# The server may return fewer than this at its discretion.
# If no value is specified (or too large a value is specified), the server
# will impose its own limit.
# @param [String] page_token
@ -1183,15 +1252,24 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the IosApp identified by the specified
# resource name.
# Updates the attributes of the specified IosApp.
# @param [String] name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>projectId</var>/iosApps/<var>appId</var></code>
# The resource name of the IosApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/iosApps/<var>APP_ID</var></code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App (see [`appId`](../projects.iosApps#IosApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::IosApp] ios_app_object
# @param [String] update_mask
# Specifies which fields to update.
# <br>Note that the fields `name`, `appId`, `projectId`, and `bundleId`
# Note that the fields `name`, `appId`, `projectId`, and `bundleId`
# are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1223,14 +1301,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Requests that a new WebApp be created.
# <br>
# <br>The result of this call is an `Operation` which can be used to track
# Requests the creation of a new WebApp in the specified
# FirebaseProject.
# The result of this call is an `Operation` which can be used to track
# the provisioning process. The `Operation` is automatically deleted after
# completion, so there is no need to call `DeleteOperation`.
# @param [String] parent
# The parent Project in which to create an App, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject in which to create a
# WebApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
@ -1261,13 +1343,18 @@ module Google
execute_or_queue_command(command, &block)
end
# Gets the WebApp identified by the specified resource name.
# Gets the specified WebApp.
# @param [String] name
# The fully qualified resource name of the App, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/webApps/<var>APP_ID</var></code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# The resource name of the WebApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code>
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/webApps/<var>APP_ID</var></code>
# <code>projects/-/webApps/<var>APP_ID</var></code>
# <br>
# Refer to the `WebApp`
# [`name`](../projects.webApps#WebApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1297,12 +1384,18 @@ module Google
# Gets the configuration artifact associated with the specified WebApp.
# @param [String] name
# The resource name of the App configuration to download, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var>/webApps/<var>APP_ID</var>/config</
# The resource name of the WebApp configuration to download,
# in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var>/config</
# code>
# <br>As an <var>APP_ID</var> is a unique identifier, the Unique Resource
# <br>
# Since an <var>APP_ID</var> is a unique identifier, the Unique Resource
# from Sub-Collection access pattern may be used here, in the format:
# <br><code>projects/-/webApps/<var>APP_ID</var></code>
# <code>projects/-/webApps/<var>APP_ID</var></code>
# <br>
# Refer to the `WebApp`
# [`name`](../projects.webApps#WebApp.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> and <var>APP_ID</var> values.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
@ -1330,18 +1423,20 @@ module Google
execute_or_queue_command(command, &block)
end
# Lists each WebApp associated with the specified parent Project.
# <br>
# <br>The elements are returned in no particular order, but will be a
# Lists each WebApp associated with the specified FirebaseProject.
# The elements are returned in no particular order, but will be a
# consistent view of the Apps when additional requests are made with a
# `pageToken`.
# @param [String] parent
# The parent Project for which to list Apps, in the format:
# <br><code>projects/<var>PROJECT_NUMBER</var></code>
# The resource name of the parent FirebaseProject for which to list each
# associated WebApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps</code>
# Refer to the `FirebaseProject`
# [`name`](../projects#FirebaseProject.FIELDS.name) field for details
# about <var>PROJECT_IDENTIFIER</var> values.
# @param [Fixnum] page_size
# The maximum number of Apps to return in the response.
# <br>
# <br>The server may return fewer than this value at its discretion.
# The server may return fewer than this value at its discretion.
# If no value is specified (or too large a value is specified), then the
# server will impose its own limit.
# @param [String] page_token
@ -1376,16 +1471,24 @@ module Google
execute_or_queue_command(command, &block)
end
# Updates the attributes of the WebApp identified by the specified
# resource name.
# Updates the attributes of the specified WebApp.
# @param [String] name
# The fully qualified resource name of the App, for example:
# <br><code>projects/<var>projectId</var>/webApps/<var>appId</var></code>
# The resource name of the WebApp, in the format:
# <code>projects/<var>PROJECT_IDENTIFIER</var>/webApps/<var>APP_ID</var></code>
# * <var>PROJECT_IDENTIFIER</var>: the parent Project's
# [`ProjectNumber`](../projects#FirebaseProject.FIELDS.project_number)
# ***(recommended)***
# or its [`ProjectId`](../projects#FirebaseProject.FIELDS.project_id).
# Learn more about using project identifiers in
# Google's [AIP 2510 standard](https://google.aip.dev/cloud/2510).
# <br>Note that the value for <var>PROJECT_IDENTIFIER</var> in any
# response body will be the `ProjectId`.
# * <var>APP_ID</var>: the globally unique, Firebase-assigned identifier
# for the App (see [`appId`](../projects.webApps#WebApp.FIELDS.app_id)).
# @param [Google::Apis::FirebaseV1beta1::WebApp] web_app_object
# @param [String] update_mask
# Specifies which fields to update.
# <br>Note that the fields `name`, `appId`, and `projectId` are all
# immutable.
# Note that the fields `name`, `appId`, and `projectId` are all immutable.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user

2
generated/google/apis/fitness_v1.rb
View File

@ -25,7 +25,7 @@ module Google
# @see https://developers.google.com/fit/rest/v1/get-started
module FitnessV1
VERSION = 'V1'
REVISION = '20200601'
REVISION = '20200724'
# Use Google Fit to see and store your physical activity data
AUTH_FITNESS_ACTIVITY_READ = 'https://www.googleapis.com/auth/fitness.activity.read'

2
generated/google/apis/storagetransfer_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://cloud.google.com/storage-transfer/docs
module StoragetransferV1
VERSION = 'V1'
REVISION = '20200605'
REVISION = '20200721'
# View and manage your data across Google Cloud Platform services
AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

28
generated/google/apis/storagetransfer_v1/service.rb
View File

@ -236,8 +236,32 @@ module Google
execute_or_queue_command(command, &block)
end
# Cancels a transfer. Use the get method to check whether the cancellation
# succeeded or whether the operation completed despite cancellation.
# Cancels a transfer. Use the
# transferOperations.get method to
# check if the cancellation succeeded or if the operation completed despite
# the `cancel` request.
# When you cancel an operation, the currently running transfer is
# interrupted. For recurring transfer jobs, the next instance of the transfer
# job
# will still run. For example, if your job is configured to run every day
# at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer
# will stop. However, a transfer job will still be attempted on Tuesday.
# This applies only to currently running operations. If an operation is
# not currently running, `cancel` does nothing.
# <aside class="caution">
# <b>Caution:</b> Canceling a transfer job can leave your data in an unknown
# state. We recommend that you restore the state at both the destination and the
# source after the `cancel` request completes so that your data is in a
# consistent
# state.
# </aside>
# When you cancel a job, the next job computes a delta of files and may repair
# any
# inconsistent state. For instance, if you run a job every day, and today's job
# found 10 new files and transferred five files before you canceled the job,
# tomorrow's transfer operation will compute a new delta with the five files
# that
# were not copied today plus any new files discovered tomorrow.
# @param [String] name
# The name of the operation resource to be cancelled.
# @param [String] fields

2
generated/google/apis/youtube_partner_v1.rb
View File

@ -26,7 +26,7 @@ module Google
# @see https://devsite.googleplex.com/youtube/partner/docs/v1/
module YoutubePartnerV1
VERSION = 'V1'
REVISION = '20200724'
REVISION = '20200727'
# View and manage your assets and associated content on YouTube
AUTH_YOUTUBEPARTNER = 'https://www.googleapis.com/auth/youtubepartner'

34
generated/google/apis/youtube_partner_v1/service.rb
View File

@ -347,7 +347,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_asset_relationships(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_asset_relationships(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assetRelationships', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetRelationshipListResponse
@ -489,7 +489,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_asset_shares(asset_id: nil, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_asset_shares(asset_id, on_behalf_of_content_owner: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assetShares', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetShareListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetShareListResponse
@ -600,6 +600,16 @@ module Google
# duplicate assets have been merged, the API response only contains the
# synthesized asset. (It does not contain the constituent assets that were
# merged into the synthesized asset.)
# @param [String] id
# The *id* parameter specifies a comma-separated list of YouTube Asset IDs that
# identify the assets you want to retrieve. As noted in the method description,
# if you try to retrieve an asset that YouTube identified as a duplicate and
# merged with another asset, the API response only returns the synthesized asset.
# In that case, the aliasId property in the asset resource specifies a list of
# other asset IDs that can be used to identify that asset. Also note that the
# API response does not contain duplicates. As such, if your request identifies
# three asset IDs, and all of those have been merged into a single asset, then
# the API response identifies one matching asset.
# @param [String] fetch_match_policy
# The *fetchMatchPolicy* parameter specifies the version of the asset's match
# policy that should be returned in the API response.
@ -615,16 +625,6 @@ module Google
# @param [Boolean] fetch_ownership_conflicts
# The *fetchOwnershipConflicts* parameter allows you to retrieve information
# about ownership conflicts.
# @param [String] id
# The *id* parameter specifies a comma-separated list of YouTube Asset IDs that
# identify the assets you want to retrieve. As noted in the method description,
# if you try to retrieve an asset that YouTube identified as a duplicate and
# merged with another asset, the API response only returns the synthesized asset.
# In that case, the aliasId property in the asset resource specifies a list of
# other asset IDs that can be used to identify that asset. Also note that the
# API response does not contain duplicates. As such, if your request identifies
# three asset IDs, and all of those have been merged into a single asset, then
# the API response identifies one matching asset.
# @param [String] on_behalf_of_content_owner
# The *onBehalfOfContentOwner* parameter identifies the content owner that the
# user is acting on behalf of. This parameter supports users whose accounts are
@ -646,7 +646,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_assets(fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_assets(id, fetch_match_policy: nil, fetch_metadata: nil, fetch_ownership: nil, fetch_ownership_conflicts: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/assets', options)
command.response_representation = Google::Apis::YoutubePartnerV1::AssetListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::AssetListResponse
@ -1403,10 +1403,10 @@ module Google
end
# Inserts a cuepoint into a live broadcast.
# @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object
# @param [String] channel_id
# The *channelId* parameter identifies the channel that owns the broadcast into
# which the cuepoint is being inserted.
# @param [Google::Apis::YoutubePartnerV1::LiveCuepoint] live_cuepoint_object
# @param [String] on_behalf_of_content_owner
# The *onBehalfOfContentOwner* parameter identifies the content owner that the
# user is acting on behalf of. This parameter supports users whose accounts are
@ -1430,7 +1430,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def insert_live_cuepoint(live_cuepoint_object = nil, channel_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
def insert_live_cuepoint(channel_id, live_cuepoint_object = nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'youtube/partner/v1/liveCuepoints', options)
command.request_representation = Google::Apis::YoutubePartnerV1::LiveCuepoint::Representation
command.request_object = live_cuepoint_object
@ -1469,7 +1469,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_metadata_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_metadata_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/metadataHistory', options)
command.response_representation = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::MetadataHistoryListResponse
@ -1635,7 +1635,7 @@ module Google
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_ownership_histories(asset_id: nil, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
def list_ownership_histories(asset_id, on_behalf_of_content_owner: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'youtube/partner/v1/ownershipHistory', options)
command.response_representation = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse::Representation
command.response_class = Google::Apis::YoutubePartnerV1::OwnershipHistoryListResponse