Class: Google::Apis::FirebaseV1beta1::FirebaseManagementService

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/firebase_v1beta1/service.rb

Overview

Firebase Management API

The Firebase Management API enables programmatic setup and management of Firebase projects, including a project's Firebase resources and Firebase apps.

Examples:

require 'google/apis/firebase_v1beta1'

Firebase = Google::Apis::FirebaseV1beta1 # Alias the module
service = Firebase::FirebaseManagementService.new

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ FirebaseManagementService

Returns a new instance of FirebaseManagementService



46
47
48
49
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 46

def initialize
  super('https://firebase.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation

Adds Firebase resources to the specified existing Google Cloud Platform (GCP) Project.

Since a FirebaseProject is actually also a GCP Project, a FirebaseProject uses underlying GCP identifiers (most importantly, the projectId) as its own for easy interop with GCP APIs.

The result of this call is an Operation. Poll the Operation to track the provisioning process by calling GetOperation until done is true. When done is true, the Operation has either succeeded or failed. If the Operation succeeded, its response is set to a FirebaseProject; if the Operation failed, its error is set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

This method does not modify any billing account information on the underlying GCP Project.

All fields listed in the request body are required.

To call AddFirebase, a member must be an Editor or Owner for the existing GCP Project. Service accounts cannot call AddFirebase.

Parameters:

  • project (String) —

    The resource name of the GCP Project to which Firebase resources will be added, in the format:
    projects/projectId After calling AddFirebase, the projectId of the GCP Project is also the projectId of the FirebaseProject.

  • add_firebase_request_object (Google::Apis::FirebaseV1beta1::AddFirebaseRequest) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



189
190
191
192
193
194
195
196
197
198
199
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 189

def add_project_firebase(project, add_firebase_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+project}:addFirebase', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::AddFirebaseRequest::Representation
  command.request_object = add_firebase_request_object
  command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Operation
  command.params['project'] = project unless project.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation

Requests that a new AndroidApp be created.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • android_app_object (Google::Apis::FirebaseV1beta1::AndroidApp) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



440
441
442
443
444
445
446
447
448
449
450
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 440

def create_project_android_app(parent, android_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/androidApps', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
  command.request_object = android_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ShaCertificate

Adds a SHA certificate to the specified AndroidApp.

Parameters:

  • parent (String) —

    The parent App to which a SHA certificate will be added, in the format:
    projects/projectId/androidApps/appId
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/androidApps/appId

  • sha_certificate_object (Google::Apis::FirebaseV1beta1::ShaCertificate) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



633
634
635
636
637
638
639
640
641
642
643
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 633

def create_project_android_app_sha(parent, sha_certificate_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/sha', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation
  command.request_object = sha_certificate_object
  command.response_representation = Google::Apis::FirebaseV1beta1::ShaCertificate::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ShaCertificate
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation

Requests that a new IosApp be created.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • ios_app_object (Google::Apis::FirebaseV1beta1::IosApp) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



738
739
740
741
742
743
744
745
746
747
748
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 738

def create_project_ios_app(parent, ios_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/iosApps', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
  command.request_object = ios_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation

Requests that a new WebApp be created.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • web_app_object (Google::Apis::FirebaseV1beta1::WebApp) (defaults to: nil)
  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



930
931
932
933
934
935
936
937
938
939
940
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 930

def create_project_web_app(parent, web_app_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/webApps', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Operation
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty

Removes a SHA certificate from the specified AndroidApp.

Parameters:

  • name (String) —

    The fully qualified resource name of the sha-key, in the format:
    projects/projectId/androidApps/appId/sha/ shaHash

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



667
668
669
670
671
672
673
674
675
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 667

def delete_project_android_app_sha(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_operation(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Operation

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

Parameters:

  • name (String) —

    The name of the operation resource.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



125
126
127
128
129
130
131
132
133
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 125

def get_operation(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::Operation::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject

Gets the FirebaseProject identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the Project, in the format:
    projects/projectId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



222
223
224
225
226
227
228
229
230
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 222

def get_project(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AdminSdkConfig

Gets the configuration artifact used by servers to simplify initialization.

Typically, this configuration is used with the Firebase Admin SDK initializeApp command.

Parameters:

  • name (String) —

    The fully qualified resource name of the Project, in the format:
    projects/projectId/adminSdkConfig

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



258
259
260
261
262
263
264
265
266
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 258

def get_project_admin_sdk_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::AdminSdkConfig::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::AdminSdkConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_android_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp

Gets the AndroidApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, in the format:
    projects/projectId/androidApps/appId
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/androidApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



476
477
478
479
480
481
482
483
484
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 476

def get_project_android_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidAppConfig

Gets the configuration artifact associated with the specified AndroidApp.

Parameters:

  • name (String) —

    The resource name of the App configuration to download, in the format:
    projects/projectId/androidApps/appId/config</ code>
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/androidApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



512
513
514
515
516
517
518
519
520
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 512

def get_project_android_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::AndroidAppConfig::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::AndroidAppConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_ios_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp

Gets the IosApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, in the format: projects/projectId/iosApps/appId
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/iosApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



774
775
776
777
778
779
780
781
782
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 774

def get_project_ios_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::IosApp
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosAppConfig

Gets the configuration artifact associated with the specified IosApp.

Parameters:

  • name (String) —

    The resource name of the App configuration to download, in the format:
    projects/projectId/iosApps/appId/config
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/iosApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



808
809
810
811
812
813
814
815
816
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 808

def get_project_ios_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::IosAppConfig::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::IosAppConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_web_app(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp

Gets the WebApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, in the format:
    projects/projectId/webApps/appId
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/webApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



966
967
968
969
970
971
972
973
974
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 966

def get_project_web_app(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::WebApp
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebAppConfig

Gets the configuration artifact associated with the specified WebApp.

Parameters:

  • name (String) —

    The resource name of the App configuration to download, in the format:
    projects/projectId/webApps/appId/config
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/webApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1000

def get_project_web_app_config(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::WebAppConfig::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::WebAppConfig
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse

Returns a list of Google Cloud Platform (GCP) Projects that are available to have Firebase resources added to them.

A GCP Project will only be returned if:

  1. The caller has sufficient [Google IAM](https://cloud.google.com/iam) permissions to call AddFirebase.

  2. The GCP `Project` is not already a FirebaseProject.

  3. The GCP `Project` is not in an Organization which has policies that prevent Firebase resources from being added.

Parameters:

  • page_size (Fixnum) —

    The maximum number of GCP 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.

    This value cannot be negative.

  • page_token (String) —

    Token returned from a previous call to ListAvailableProjects indicating where in the set of GCP Projects to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



92
93
94
95
96
97
98
99
100
101
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 92

def list_available_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/availableProjects', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableProjectsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse

Returns the list of SHA-1 and SHA-256 certificates for the specified AndroidApp.

Parameters:

  • parent (String) —

    The parent App for which to list SHA certificates, in the format:
    projects/projectId/androidApps/appId
    As an appId is a unique identifier, the Unique Resource from Sub-Collection access pattern may be used here, in the format:
    projects/-/androidApps/appId

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



702
703
704
705
706
707
708
709
710
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 702

def list_project_android_app_shas(parent, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/sha', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListShaCertificatesResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse

Lists each AndroidApp associated with the specified parent Project.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • page_size (Fixnum) —

    The maximum number of Apps to return in the response.

    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.

  • page_token (String) —

    Token returned from a previous call to ListAndroidApps indicating where in the set of Apps to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



556
557
558
559
560
561
562
563
564
565
566
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 556

def list_project_android_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/androidApps', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListAndroidAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListIosAppsResponse

Lists each IosApp associated with the specified parent Project.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • page_size (Fixnum) —

    The maximum number of Apps to return in the response.

    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.

  • page_token (String) —

    Token returned from a previous call to ListIosApps indicating where in the set of Apps to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



852
853
854
855
856
857
858
859
860
861
862
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 852

def list_project_ios_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/iosApps', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListIosAppsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListIosAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListWebAppsResponse

Lists each WebApp associated with the specified parent Project.

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.

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • page_size (Fixnum) —

    The maximum number of Apps 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), then the server will impose its own limit.

  • page_token (String) —

    Token returned from a previous call to ListWebApps indicating where in the set of Apps to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1044

def list_project_web_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/webApps', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListWebAppsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListWebAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse

Lists each FirebaseProject accessible to the caller.

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.

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.

Use GetFirebaseProject for consistent reads as well as for additional Project details.

Parameters:

  • page_size (Fixnum) —

    The maximum number of Projects to return in the response.

    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.

    This value cannot be negative.

  • page_token (String) —

    Token returned from a previous call to ListFirebaseProjects indicating where in the set of Projects to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



310
311
312
313
314
315
316
317
318
319
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 310

def list_projects(page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/projects', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListFirebaseProjectsResponse
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::FirebaseProject

Updates the attributes of the FirebaseProject identified by the specified resource name.

All query parameters are required.

Parameters:

  • name (String) —

    The fully qualified resource name of the Project, in the format:
    projects/projectId

  • firebase_project_object (Google::Apis::FirebaseV1beta1::FirebaseProject) (defaults to: nil)
  • update_mask (String) —

    Specifies which fields to update.

    If this list is empty, then no state will be updated.
    Note that the fields name, project_id, and project_number are all immutable.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 352

def patch_project(name, firebase_project_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
  command.request_object = firebase_project_object
  command.response_representation = Google::Apis::FirebaseV1beta1::FirebaseProject::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::FirebaseProject
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AndroidApp

Updates the attributes of the AndroidApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, in the format:
    projects/projectId/androidApps/appId

  • android_app_object (Google::Apis::FirebaseV1beta1::AndroidApp) (defaults to: nil)
  • update_mask (String) —

    Specifies which fields to update.
    Note that the fields name, appId, projectId, and packageName are all immutable.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 595

def patch_project_android_app(name, android_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
  command.request_object = android_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::AndroidApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::AndroidApp
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::IosApp

Updates the attributes of the IosApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, in the format:
    projects/projectId/iosApps/appId

  • ios_app_object (Google::Apis::FirebaseV1beta1::IosApp) (defaults to: nil)
  • update_mask (String) —

    Specifies which fields to update.
    Note that the fields name, appId, projectId, and bundleId are all immutable.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 891

def patch_project_ios_app(name, ios_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
  command.request_object = ios_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::IosApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::IosApp
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::WebApp

Updates the attributes of the WebApp identified by the specified resource name.

Parameters:

  • name (String) —

    The fully qualified resource name of the App, for example:
    projects/projectId/webApps/appId

  • web_app_object (Google::Apis::FirebaseV1beta1::WebApp) (defaults to: nil)
  • update_mask (String) —

    Specifies which fields to update.
    Note that the fields name, appId, and projectId are all immutable.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1083

def patch_project_web_app(name, web_app_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1beta1/{+name}', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
  command.request_object = web_app_object
  command.response_representation = Google::Apis::FirebaseV1beta1::WebApp::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::WebApp
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#search_project_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse

A convenience method that lists all available Apps for the specified FirebaseProject.

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).

Parameters:

  • parent (String) —

    The parent Project for which to list Apps, in the format:
    projects/projectId

  • page_size (Fixnum) —

    The maximum number of Apps 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), then the server will impose its own limit.

    This value cannot be negative.

  • page_token (String) —

    Token returned from a previous call to SearchFirebaseApps indicating where in the set of Apps to resume listing.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



402
403
404
405
406
407
408
409
410
411
412
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 402

def search_project_apps(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}:searchApps', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::SearchFirebaseAppsResponse
  command.params['parent'] = parent unless parent.nil?
  command.query['pageSize'] = page_size unless page_size.nil?
  command.query['pageToken'] = page_token unless page_token.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end