histories

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

Overview

Name	histories
Type	Resource
Id	firebase.toolresults.histories

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set
displayName	string	A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional
historyId	string	A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set
testPlatform	string	The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown.

list

Successful response

Name	Datatype	Description
name	string	A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set
displayName	string	A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional
historyId	string	A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set
testPlatform	string	The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectId, historyId		Gets a History. 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 History does not exist
list	select	projectId	pageToken, pageSize, filterByName	Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. 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 History does not exist
create	insert	projectId	requestId	Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project 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
historyId	string
projectId	string
filterByName	string
pageSize	integer (int32)
pageToken	string
requestId	string

SELECT examples

get

Gets a History. 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 History does not exist

SELECT
name,
displayName,
historyId,
testPlatform
FROM firebase.toolresults.histories
WHERE projectId = '{{ projectId }}' -- required
AND historyId = '{{ historyId }}' -- required;

list

Lists Histories for a given Project. The histories are sorted by modification time in descending order. The history_id key will be used to order the history with the same modification time. 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 History does not exist

SELECT
name,
displayName,
historyId,
testPlatform
FROM firebase.toolresults.histories
WHERE projectId = '{{ projectId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}'
AND filterByName = '{{ filterByName }}';

INSERT examples

create

Creates a History. The returned History will have the id set. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write to project - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the containing project does not exist

INSERT INTO firebase.toolresults.histories (
data__historyId,
data__name,
data__displayName,
data__testPlatform,
projectId,
requestId
)
SELECT 
'{{ historyId }}',
'{{ name }}',
'{{ displayName }}',
'{{ testPlatform }}',
'{{ projectId }}',
'{{ requestId }}'
RETURNING
name,
displayName,
historyId,
testPlatform
;

Manifest

# Description fields are for documentation purposes
- name: histories
  props:
    - name: projectId
      value: string
      description: Required parameter for the histories resource.
    - name: historyId
      value: string
      description: >
        A unique identifier within a project for this History. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create request: never set
        
    - name: name
      value: string
      description: >
        A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set
        
    - name: displayName
      value: string
      description: >
        A short human-readable (plain text) name to display in the UI. Maximum of 100 characters. - In response: present if set during create. - In create request: optional
        
    - name: testPlatform
      value: string
      description: >
        The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown.
        
      valid_values: ['unknownPlatform', 'android', 'ios']
    - name: requestId
      value: string