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.



610
611
612
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 610

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

A set of user-defined annotations for the FirebaseProject. Learn more about annotations in Google's AIP-128 standard. These annotations are intended solely for developers and client- side tools. Firebase services will not mutate this annotations set. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


554
555
556
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 554

def annotations
  @annotations
end

#display_name ⇒ String

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

Returns:

  • (String) 


559
560
561
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 559

def display_name
  @display_name
end

#etag ⇒ String

This checksum is computed by the server based on the value of other fields, and it may be sent with update requests to ensure the client has an up-to-date value before proceeding. Learn more about etag in Google's AIP-154 standard. This etag is strongly validated. Corresponds to the JSON property etag

Returns:

  • (String) 


568
569
570
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 568

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) 


579
580
581
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 579

def name
  @name
end

#project_id ⇒ String

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

Returns:

  • (String) 


587
588
589
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 587

def project_id
  @project_id
end

#project_number ⇒ Fixnum

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

Returns:

  • (Fixnum) 


594
595
596
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 594

def project_number
  @project_number
end

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

DEPRECATED. Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the resources within the Project. Instead, retrieve information about each resource directly from its resource-specific API. The default auto-provisioned resources associated with the Project. Corresponds to the JSON property resources

Returns:



603
604
605
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 603

def resources
  @resources
end

#state ⇒ String

Output only. The lifecycle state of the Project. Corresponds to the JSON property state

Returns:

  • (String) 


608
609
610
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 608

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



615
616
617
618
619
620
621
622
623
624
 
# File 'lib/google/apis/firebase_v1beta1/classes.rb', line 615

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