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.

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:



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

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

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

Links a FirebaseProject with an existing Google Analytics account.

Using this call, you can either:

  • Provision a new Google Analytics property and associate the new property with your `FirebaseProject`.
  • Associate an existing Google Analytics property with your `FirebaseProject`.


Note that when you call AddGoogleAnalytics:

  • Any Firebase Apps already in your `FirebaseProject` are automatically provisioned as new data streams in the Google Analytics property.
  • Any data streams already in the Google Analytics property are automatically associated with their corresponding Firebase Apps (only applies when an app's `packageName` or `bundleId` match those for an existing data stream).

Learn more about the hierarchy and structure of Google Analytics accounts in the Analytics documentation.

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 an AnalyticsDetails; if the Operation failed, its error is set to a google.rpc.Status.

To call AddGoogleAnalytics, a member must be an Owner for the existing FirebaseProject and have the Edit permission for the Google Analytics account.

If a 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.

Parameters:

  • parent (String) —

    The parent FirebaseProject to link to an existing Google Analytics account, in the format:
    projects/projectId

  • add_google_analytics_request_object (Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest) (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:



269
270
271
272
273
274
275
276
277
278
279
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 269

def add_project_google_analytics(parent, add_google_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:addGoogleAnalytics', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::AddGoogleAnalyticsRequest::Representation
  command.request_object = add_google_analytics_request_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(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:



603
604
605
606
607
608
609
610
611
612
613
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 603

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:



796
797
798
799
800
801
802
803
804
805
806
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 796

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:



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

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:



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1235

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/ shaId
    You can obtain the full name from the response of ListShaCertificates or the original CreateShaCertificate.

  • 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:



833
834
835
836
837
838
839
840
841
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 833

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

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

Sets the default Google Cloud Platform (GCP) resource location for the specified FirebaseProject.

This method creates an App Engine application with a default Cloud Storage bucket, located in the specified location_id. This location must be one of the available GCP resource 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 FinalizeDefaultLocation was previously called with a specified location_id. Any new calls to FinalizeDefaultLocation with a different specified location_id will return a 409 error.

The result of this call is an Operation, which can be used to track the provisioning process. The response type of the Operation is google.protobuf.Empty.

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 response will be set to a google.protobuf.Empty; if the Operation has failed, its error will be set to a google.rpc.Status. The Operation is automatically deleted after completion, so there is no need to call DeleteOperation.

All fields listed in the request body are required.

To call FinalizeDefaultLocation, a member must be an Owner of the project.

Parameters:

  • parent (String) —

    The resource name of the Project for which the default GCP resource location will be set, in the format:
    projects/projectId

  • finalize_default_location_request_object (Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest) (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:



1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1005

def finalize_default_location(parent, finalize_default_location_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}/defaultLocation:finalize', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::FinalizeDefaultLocationRequest::Representation
  command.request_object = finalize_default_location_request_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

#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:



302
303
304
305
306
307
308
309
310
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 302

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:



338
339
340
341
342
343
344
345
346
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 338

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_analytics_details(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::AnalyticsDetails

Gets the Google Analytics details currently associated with a FirebaseProject.

If the FirebaseProject is not yet linked to Google Analytics, then the response to GetAnalyticsDetails is NOT_FOUND.

Parameters:

  • name (String) —

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

  • 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:



373
374
375
376
377
378
379
380
381
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 373

def get_project_analytics_details(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+name}', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::AnalyticsDetails::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::AnalyticsDetails
  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:



639
640
641
642
643
644
645
646
647
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 639

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:



675
676
677
678
679
680
681
682
683
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 675

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:



1079
1080
1081
1082
1083
1084
1085
1086
1087
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1079

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:



1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1113

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:



1271
1272
1273
1274
1275
1276
1277
1278
1279
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1271

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:



1305
1306
1307
1308
1309
1310
1311
1312
1313
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1305

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:



868
869
870
871
872
873
874
875
876
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 868

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:



719
720
721
722
723
724
725
726
727
728
729
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 719

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_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse

Returns a list of valid Google Cloud Platform (GCP) resource locations for the specified Project (including a FirebaseProject).

The default GCP resource location of a project defines the geographical location where project resources, such as Cloud Firestore, will be provisioned by default.

The returned list are the available GCP resource locations.

This call checks for any location restrictions 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 projectId (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.

Parameters:

  • parent (String) —

    The Project for which to list GCP resource locations, in the format:
    projects/projectId
    If no project is specified (that is, projects/-), the returned list does not take into account org-specific or project-specific location restrictions.

  • page_size (Fixnum) —

    The maximum number of locations 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 ListAvailableLocations indicating where in the list of locations 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:



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

def list_project_available_locations(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1beta1/{+parent}/availableLocations', options)
  command.response_representation = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::ListAvailableLocationsResponse
  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:



1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1157

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:



1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1349

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:



425
426
427
428
429
430
431
432
433
434
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 425

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:



467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 467

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:



758
759
760
761
762
763
764
765
766
767
768
769
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 758

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:



1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1196

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:



1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 1388

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

#remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::FirebaseV1beta1::Empty

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.

These resources may be re-associated later to the FirebaseProject by calling AddGoogleAnalytics and specifying the same analyticsPropertyId.

To call RemoveAnalytics, a member must be an Owner for the FirebaseProject.

Parameters:

  • parent (String) —

    The parent FirebaseProject to unlink from its Google Analytics account, in the format:
    projects/projectId

  • remove_analytics_request_object (Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest) (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:



516
517
518
519
520
521
522
523
524
525
526
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 516

def remove_project_analytics(parent, remove_analytics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1beta1/{+parent}:removeAnalytics', options)
  command.request_representation = Google::Apis::FirebaseV1beta1::RemoveAnalyticsRequest::Representation
  command.request_object = remove_analytics_request_object
  command.response_representation = Google::Apis::FirebaseV1beta1::Empty::Representation
  command.response_class = Google::Apis::FirebaseV1beta1::Empty
  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

#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:



565
566
567
568
569
570
571
572
573
574
575
 
# File 'generated/google/apis/firebase_v1beta1/service.rb', line 565

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