Class: Google::Apis::FirebaseV1beta1::WebAppConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/firebase_v1beta1/classes.rb,
lib/google/apis/firebase_v1beta1/representations.rb,
lib/google/apis/firebase_v1beta1/representations.rb

Overview

Configuration metadata of a single Firebase App for the web.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ WebAppConfig

Returns a new instance of WebAppConfig.



1791
1792
1793
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1791

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#api_key ⇒ String

The keyString of the API key associated with the WebApp. Note that this value is not the apiKeyId (the UID) of the API key associated with the WebApp. Corresponds to the JSON property apiKey

Returns:

  • (String) 


1699
1700
1701
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1699

def api_key
  @api_key
end

#app_id ⇒ String

Immutable. The globally unique, Firebase-assigned identifier for the WebApp. Corresponds to the JSON property appId

Returns:

  • (String) 


1704
1705
1706
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1704

def app_id
  @app_id
end

#auth_domain ⇒ String

The domain Firebase Auth configures for OAuth redirects, in the format: PROJECT_ID.firebaseapp.com Corresponds to the JSON property authDomain

Returns:

  • (String) 


1710
1711
1712
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1710

def auth_domain
  @auth_domain
end

#database_url ⇒ String

DEPRECATED. Instead, find the default Firebase Realtime Database instance name using the list endpoint within the Firebase Realtime Database REST API. Note that the default instance for the Project might not yet be provisioned, so the return might not contain a default instance. The default Firebase Realtime Database URL. Corresponds to the JSON property databaseURL

Returns:

  • (String) 


1720
1721
1722
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1720

def database_url
  @database_url
end

#location_id ⇒ String

DEPRECATED. Instead, use product-specific REST APIs to find the location of resources. The ID of the Project's default GCP resource location. The location is one of the available GCP resource 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 after you add Firebase resources to the Project. Corresponds to the JSON property locationId

Returns:

  • (String) 


1731
1732
1733
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1731

def location_id
  @location_id
end

#measurement_id ⇒ String

The unique Google-assigned identifier of the Google Analytics web stream associated with the WebApp. Firebase SDKs use this ID to interact with Google Analytics APIs. This field is only present if the WebApp is linked to a web stream in a Google Analytics App + Web property. Learn more about this ID and Google Analytics web streams in the Analytics documentation. To generate a measurementId and link the WebApp with a Google Analytics web stream, call AddGoogleAnalytics. For apps using the Firebase JavaScript SDK v7.20.0 and later, Firebase dynamically fetches the measurementId when your app initializes Analytics. Having this ID in your config object is optional, but it does serve as a fallback in the rare case that the dynamic fetch fails. Corresponds to the JSON property measurementId

Returns:

  • (String) 


1747
1748
1749
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1747

def measurement_id
  @measurement_id
end

#messaging_sender_id ⇒ String

The sender ID for use with Firebase Cloud Messaging. Corresponds to the JSON property messagingSenderId

Returns:

  • (String) 


1752
1753
1754
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1752

def messaging_sender_id
  @messaging_sender_id
end

#project_id ⇒ String

Immutable. A user-assigned unique identifier for the FirebaseProject. Corresponds to the JSON property projectId

Returns:

  • (String) 


1757
1758
1759
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1757

def project_id
  @project_id
end

#project_number ⇒ String

Output only. Immutable. The globally unique, Google-assigned canonical identifier for the Project. Use this identifier when configuring integrations and/or making API calls to Google Cloud or third-party services. Corresponds to the JSON property projectNumber

Returns:

  • (String) 


1764
1765
1766
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1764

def project_number
  @project_number
end

#realtime_database_url ⇒ String

Optional. Duplicate field for the URL of the default RTDB instances (if there is one) that uses the same field name as the unified V2 config file format. We wanted to make a single config file format for all the app platforms (Android, iOS and web) and we had to pick consistent names for all the fields since there was some varience between the platforms. If the request asks for the V2 format we will populate this field instead of realtime_database_instance_uri. Corresponds to the JSON property realtimeDatabaseUrl

Returns:

  • (String) 


1774
1775
1776
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1774

def realtime_database_url
  @realtime_database_url
end

#storage_bucket ⇒ String

DEPRECATED. Instead, find the default Cloud Storage for Firebase bucket using the list endpoint within the Cloud Storage for Firebase REST API. Note that the default bucket for the Project might not yet be provisioned, so the return might not contain a default bucket. The default Cloud Storage for Firebase storage bucket name. Corresponds to the JSON property storageBucket

Returns:

  • (String) 


1784
1785
1786
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1784

def storage_bucket
  @storage_bucket
end

#version ⇒ String

Version of the config specification. Corresponds to the JSON property version

Returns:

  • (String) 


1789
1790
1791
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1789

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 1796

def update!(**args)
  @api_key = args[:api_key] if args.key?(:api_key)
  @app_id = args[:app_id] if args.key?(:app_id)
  @auth_domain = args[:auth_domain] if args.key?(:auth_domain)
  @database_url = args[:database_url] if args.key?(:database_url)
  @location_id = args[:location_id] if args.key?(:location_id)
  @measurement_id = args[:measurement_id] if args.key?(:measurement_id)
  @messaging_sender_id = args[:messaging_sender_id] if args.key?(:messaging_sender_id)
  @project_id = args[:project_id] if args.key?(:project_id)
  @project_number = args[:project_number] if args.key?(:project_number)
  @realtime_database_url = args[:realtime_database_url] if args.key?(:realtime_database_url)
  @storage_bucket = args[:storage_bucket] if args.key?(:storage_bucket)
  @version = args[:version] if args.key?(:version)
end