Class: Google::Apis::FirebaseV1beta1::FirebaseProject

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

Overview

A FirebaseProject is the top-level Firebase entity. It is the container for Firebase Apps, Firebase Hosting sites, storage systems (Firebase Realtime Database, Cloud Firestore, Cloud Storage buckets), and other Firebase and Google Cloud Platform (GCP) resources. You create a FirebaseProject by calling AddFirebase and specifying an existing GCP Project. This adds Firebase resources to the existing GCP Project. Since a FirebaseProject is actually also a GCP Project, a FirebaseProject has the same underlying GCP identifiers (projectNumber and projectId). This allows for easy interop with Google APIs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FirebaseProject

Returns a new instance of FirebaseProject.



540
541
542
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 540

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Set of user-defined annotations for the FirebaseProject as per AIP-128. These annotations are intended solely for developers and client-side tools Firebase services will not mutate this annotation set. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


487
488
489
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 487

def annotations
  @annotations
end

#display_name ⇒ String

The user-assigned display name of the Project. Corresponds to the JSON property displayName

Returns:

  • (String) 


492
493
494
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 492

def display_name
  @display_name
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. AIP-154. This etag is strongly validated. Corresponds to the JSON property etag

Returns:

  • (String) 


500
501
502
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 500

def etag
  @etag
end

#name ⇒ String

The resource name of the Project, in the format: projects/PROJECT_IDENTIFIER PROJECT_IDENTIFIER: the Project's ProjectNumber (recommended) or its ProjectId. Learn more about using project identifiers in Google's AIP 2510 standard. Note that the value for PROJECT_IDENTIFIER in any response body will be the ProjectId. Corresponds to the JSON property name

Returns:

  • (String) 


511
512
513
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 511

def name
  @name
end

#project_id ⇒ String

Output only. A user-assigned unique identifier for the Project. This identifier may appear in URLs or names for some Firebase resources associated with the Project, but it should generally be treated as a convenience alias to reference the Project. Corresponds to the JSON property projectId

Returns:

  • (String) 


519
520
521
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 519

def project_id
  @project_id
end

#project_number ⇒ Fixnum

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

Returns:

  • (Fixnum) 


526
527
528
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 526

def project_number
  @project_number
end

#resources ⇒ Google::Apis::FirebaseV1beta1::DefaultResources

The default resources associated with the Project. Corresponds to the JSON property resources

Returns:



531
532
533
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 531

def resources
  @resources
end

#state ⇒ String

Output only. The lifecycle state of the Project. Updates to the state must be performed via com.google.cloudresourcemanager.v1.Projects.DeleteProject and com.google.cloudresourcemanager.v1.Projects.UndeleteProject Corresponds to the JSON property state

Returns:

  • (String) 


538
539
540
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 538

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



545
546
547
548
549
550
551
552
553
554
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 545

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @display_name = args[:display_name] if args.key?(:display_name)
  @etag = args[:etag] if args.key?(:etag)
  @name = args[:name] if args.key?(:name)
  @project_id = args[:project_id] if args.key?(:project_id)
  @project_number = args[:project_number] if args.key?(:project_number)
  @resources = args[:resources] if args.key?(:resources)
  @state = args[:state] if args.key?(:state)
end