projects

Creates, updates, deletes, gets or lists a projects resource.

Overview

Name	projects
Type	Resource
Id	firebase.firebase.projects

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
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.
annotations	object	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.
displayName	string	The user-assigned display name of the Project.
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.
projectId	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.
projectNumber	string (int64)	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.
resources	object	Output only. DEPRECATED. Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API. The default Firebase resources associated with the Project. (id: DefaultResources)
state	string	Output only. The lifecycle state of the Project.

list

Successful response

Name	Datatype	Description
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.
annotations	object	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.
displayName	string	The user-assigned display name of the Project.
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.
projectId	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.
projectNumber	string (int64)	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.
resources	object	Output only. DEPRECATED. Auto-provisioning of these resources is changing, so this object no longer reliably provides information about the Project. Instead, retrieve information about each resource directly from its resource-specific API. The default Firebase resources associated with the Project. (id: DefaultResources)
state	string	Output only. The lifecycle state of the Project.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId		Gets the specified FirebaseProject.
list	select		pageToken, pageSize, showDeleted	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.
patch	update	projectsId	updateMask	Updates the attributes of the specified FirebaseProject. All query parameters are required.
search_apps	exec	projectsId	pageToken, pageSize, filter, showDeleted	Lists all available Apps for the specified FirebaseProject. This is a convenience method. 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

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
showDeleted	boolean
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the specified FirebaseProject.

SELECT
name,
annotations,
displayName,
etag,
projectId,
projectNumber,
resources,
state
FROM firebase.firebase.projects
WHERE projectsId = '{{ projectsId }}' -- required;

list

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.

SELECT
name,
annotations,
displayName,
etag,
projectId,
projectNumber,
resources,
state
FROM firebase.firebase.projects
WHERE pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND showDeleted = '{{ showDeleted }}';

UPDATE examples

patch

Updates the attributes of the specified FirebaseProject. All query parameters are required.

UPDATE firebase.firebase.projects
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__annotations = '{{ annotations }}',
data__etag = '{{ etag }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
annotations,
displayName,
etag,
projectId,
projectNumber,
resources,
state;

Lifecycle Methods

search_apps

Lists all available Apps for the specified FirebaseProject. This is a convenience method. 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).

EXEC firebase.firebase.projects.search_apps 
@projectsId='{{ projectsId }}' --required, 
@pageToken='{{ pageToken }}', 
@pageSize='{{ pageSize }}', 
@filter='{{ filter }}', 
@showDeleted={{ showDeleted }};