environments

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

Overview

Name	environments
Type	Resource
Id	firebase.toolresults.environments

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
completionTime	object	Output only. The time when the Environment status was set to complete. This value will be set automatically when state transitions to COMPLETE. (id: Timestamp)
creationTime	object	Output only. The time when the Environment was created. (id: Timestamp)
dimensionValue	array	Dimension 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
displayName	string	A short human-readable name to display in the UI. Maximum of 100 characters. For example: Nexus 5, API 27.
environmentId	string	Output only. An Environment id.
environmentResult	object	Merged result of the environment. (id: MergedResult)
executionId	string	Output only. An Execution id.
historyId	string	Output only. A History id.
projectId	string	Output only. A Project id.
resultsStorage	object	The location where output files are stored in the user bucket. (id: ResultsStorage)
shardSummaries	array	Output only. Summaries of shards. Only one shard will present unless sharding feature is enabled in TestExecutionService.

list

Successful response

Name	Datatype	Description
completionTime	object	Output only. The time when the Environment status was set to complete. This value will be set automatically when state transitions to COMPLETE. (id: Timestamp)
creationTime	object	Output only. The time when the Environment was created. (id: Timestamp)
dimensionValue	array	Dimension 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
displayName	string	A short human-readable name to display in the UI. Maximum of 100 characters. For example: Nexus 5, API 27.
environmentId	string	Output only. An Environment id.
environmentResult	object	Merged result of the environment. (id: MergedResult)
executionId	string	Output only. An Execution id.
historyId	string	Output only. A History id.
projectId	string	Output only. A Project id.
resultsStorage	object	The location where output files are stored in the user bucket. (id: ResultsStorage)
shardSummaries	array	Output 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:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, historyId, executionId, environmentId		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
list	select	projectId, historyId, executionId	pageToken, pageSize	Lists 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.

Name	Datatype	Description
environmentId	string
executionId	string
historyId	string
projectId	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

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;

list

Lists 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

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 pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';