Skip to main content

environments

Creates, updates, deletes, gets or lists an environments resource.

Overview​

Nameenvironments
TypeResource
Idfirebase.toolresults.environments

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
completionTimeobjectOutput only. The time when the Environment status was set to complete. This value will be set automatically when state transitions to COMPLETE. (id: Timestamp)
creationTimeobjectOutput only. The time when the Environment was created. (id: Timestamp)
dimensionValuearrayDimension values describing the environment. Dimension values always consist of "Model", "Version", "Locale", and "Orientation". - In response: always set - In create request: always set - In update request: never set
displayNamestringA short human-readable name to display in the UI. Maximum of 100 characters. For example: Nexus 5, API 27.
environmentIdstringOutput only. An Environment id.
environmentResultobjectMerged result of the environment. (id: MergedResult)
executionIdstringOutput only. An Execution id.
historyIdstringOutput only. A History id.
projectIdstringOutput only. A Project id.
resultsStorageobjectThe location where output files are stored in the user bucket. (id: ResultsStorage)
shardSummariesarrayOutput only. Summaries of shards. Only one shard will present unless sharding feature is enabled in TestExecutionService.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectprojectId, historyId, executionId, environmentIdGets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist
listselectprojectId, historyId, executionIdpageToken, pageSizeLists Environments for a given Execution. The Environments are sorted by display name. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing Execution does not exist

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.

NameDatatypeDescription
environmentIdstring
executionIdstring
historyIdstring
projectIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples​

Gets an Environment. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the Environment does not exist

SELECT
completionTime,
creationTime,
dimensionValue,
displayName,
environmentId,
environmentResult,
executionId,
historyId,
projectId,
resultsStorage,
shardSummaries
FROM firebase.toolresults.environments
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required
AND executionId = '{{ executionId }}' -- required
AND environmentId = '{{ environmentId }}' -- required
;