package google.devtools.resultstore.v2
Get desktop application:
View/edit binary Protocol Buffers messages
This is the interface used to download information from the database. Every request supports setting a response FieldMask via the 'fields' parameter. Each resource in this interface carries a name field that identifies the resource.
Retrieves the action with the given name. An error will be reported in the following cases: - If the action is not found. - If the given name is badly formatted.
message
resultstore_download.proto:345Request passed into GetAction
string name = 1
The name of the action to retrieve. It must match this format: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIGURATION_ID}/actions/${ACTION_ID}
Retrieves the configuration with the given name. An error will be reported in the following cases: - If the configuration or its parent invocation is not found. - If the given configuration name is badly formatted.
message
resultstore_download.proto:230Request passed into GetConfiguration
string name = 1
The name of the configuration to retrieve. It must match this format: invocations/${INVOCATION_ID}/configs/${CONFIGURATION_ID}
Retrieves the configured target with the given name. An error will be reported in the following cases: - If the configured target is not found. - If the given name is badly formatted.
message
resultstore_download.proto:306Request passed into GetConfiguredTarget
string name = 1
The name of the configured target to retrieve. It must match this format: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIGURATION_ID}
Retrieves the file set with the given name. An error will be reported in the following cases: - If the file set or its parent invocation is not found. - If the given file set name is badly formatted.
message
resultstore_download.proto:384Request passed into GetFileSet
string name = 1
The name of the file set to retrieve. It must match this format: invocations/${INVOCATION_ID}/fileSets/${FILE_SET_ID}
Retrieves the invocation with the given name. An error will be reported in the following cases: - If the invocation is not found. - If the given invocation name is badly formatted.
message
resultstore_download.proto:188Request passed into GetInvocation
string name = 1
The name of the invocation to retrieve. It must match this format: invocations/${INVOCATION_ID} where INVOCATION_ID must be an RFC 4122-compliant random UUID.
Retrieves the target with the given name. An error will be reported in the following cases: - If the target or its parent invocation is not found. - If the given target name is badly formatted.
message
resultstore_download.proto:268Request passed into GetTarget
string name = 1
The name of the target to retrieve. It must match this format: invocations/${INVOCATION_ID}/targets/${TARGET_ID}
Retrieves all actions for a parent invocation/target/configuration. This might be limited by user or server, in which case a continuation token is provided. Supports '-' for configurationId to mean all actions for all configurations for a target, or '-' for targetId and configurationId to mean all actions for all configurations and all targets. Does not support targetId '-' with a specified configuration. An error will be reported in the following cases: - If the parent is not found. - If the given parent name is badly formatted.
message
resultstore_download.proto:352Request passed into ListActions
string parent = 1
The invocation, target, and configuration name of the action to retrieve. It must match this format: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIGURATION_ID}
int32 page_size = 2
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
int64 offset = 4
Absolute number of results to skip.
message
resultstore_download.proto:373Response from calling ListActions
repeated actions = 1
Actions matching the request, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Retrieves all configurations for a parent invocation. This might be limited by user or server, in which case a continuation token is provided. An error will be reported in the following cases: - If the parent invocation is not found. - If the given parent invocation name is badly formatted.
message
resultstore_download.proto:237Request passed into ListConfigurations
string parent = 1
The invocation name of the configurations to retrieve. It must match this format: invocations/${INVOCATION_ID}
int32 page_size = 2
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
int64 offset = 4
Absolute number of results to skip.
message
resultstore_download.proto:257Response from calling ListConfigurations
repeated configurations = 1
Configurations matching the request invocation, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Retrieves all configured targets for a parent invocation/target. This might be limited by user or server, in which case a continuation token is provided. Supports '-' for targetId meaning all targets. An error will be reported in the following cases: - If the parent is not found. - If the given parent name is badly formatted.
message
resultstore_download.proto:313Request passed into ListConfiguredTargets
string parent = 1
The invocation and target name of the configured targets to retrieve. It must match this format: invocations/${INVOCATION_ID}/targets/${TARGET_ID}
int32 page_size = 2
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
int64 offset = 4
Absolute number of results to skip.
message
resultstore_download.proto:334Response from calling ListConfiguredTargets
repeated configured_targets = 1
ConfiguredTargets matching the request, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Retrieves all file sets for a parent invocation. This might be limited by user or server, in which case a continuation token is provided. An error will be reported in the following cases: - If the parent invocation is not found. - If the given parent invocation name is badly formatted.
message
resultstore_download.proto:391Request passed into ListFileSets
string parent = 1
The invocation name of the file sets to retrieve. It must match this format: invocations/${INVOCATION_ID}
int32 page_size = 2
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
int64 offset = 4
Absolute number of results to skip.
message
resultstore_download.proto:411Response from calling ListFileSets
repeated file_sets = 1
File sets matching the request, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Retrieves all targets for a parent invocation. This might be limited by user or server, in which case a continuation token is provided. An error will be reported in the following cases: - If the parent is not found. - If the given parent name is badly formatted.
message
resultstore_download.proto:275Request passed into ListTargets
string parent = 1
The invocation name of the targets to retrieve. It must match this format: invocations/${INVOCATION_ID}
int32 page_size = 2
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 3
The next_page_token value returned from a previous List request, if any.
int64 offset = 4
Absolute number of results to skip.
message
resultstore_download.proto:295Response from calling ListTargetsResponse
repeated targets = 1
Targets matching the request invocation, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results in the list.
Searches for invocations matching the given query parameters. An error will be reported in the following cases: - If a query string is not provided
message
resultstore_download.proto:196Request passed into SearchInvocations
int32 page_size = 1
The maximum number of items to return. Zero means all, but may be capped by the server.
oneof page_start
Options for pagination.
string page_token = 2
The next_page_token value returned from a previous Search request, if any.
int64 offset = 3
Absolute number of results to skip.
string query = 4
A filtering query string.
string project_id = 5
The project id to search under.
message
resultstore_download.proto:219Response from calling SearchInvocations
repeated invocations = 1
Invocations matching the search, possibly capped at request.page_size or a server limit.
string next_page_token = 2
Token to retrieve the next page of results, or empty if there are no more results.
This API allows download of File messages referenced in ResultStore resources.
rpc GetFile (, stream )
resultstore_file_download.proto:35Retrieves the File with the given uri. returns a stream of bytes to be stitched together in order. An error will be reported in the following cases: - If the File is not found. - If the given File uri is badly formatted.
Request object for GetFile
string uri = 1
This corresponds to the uri field in the File message.
int64 read_offset = 2
The offset for the first byte to return in the read, relative to the start of the resource. A `read_offset` that is negative or greater than the size of the resource will cause an `OUT_OF_RANGE` error.
int64 read_limit = 3
The maximum number of `data` bytes the server is allowed to return in the sum of all `ReadResponse` messages. A `read_limit` of zero indicates that there is no limit, and a negative `read_limit` will cause an error. If the stream returns fewer bytes than allowed by the `read_limit` and no error occurred, the stream includes all data from the `read_offset` to the end of the resource.
Response object for GetFile
bytes data = 1
The file data.
Retrieves the tail of a File with the given uri. An error will be reported in the following cases: - If the File is not found. - If the given File uri is badly formatted.
Request object for GetFileTail
string uri = 1
This corresponds to the uri field in the File message.
int64 read_offset = 2
The offset for the first byte to return in the read, relative to the end of the resource. A `read_offset` that is negative or greater than the size of the resource will cause an `OUT_OF_RANGE` error.
int64 read_limit = 3
The maximum number of `data` bytes the server is allowed to return. The server will return bytes starting from the tail of the file. A `read_limit` of zero indicates that there is no limit, and a negative `read_limit` will cause an error.
Response object for GetFileTail
bytes data = 1
The file data, encoded with UTF-8.
message
action.proto:37An action that happened as part of a configured target. This action could be a build, a test, or another type of action. Each parent ConfiguredTarget resource should have at least one Action as its child resource before the invocation is finalized. ResultStore is a tool to store build & test results. ConfiguredTarget proto by itself does not contain enough fields to fully represent such results. For a simple build, at least one build action is required to represent the build result.
Used as response type in: ResultStoreDownload.GetAction
Used as field type in:
string name = 1
The resource name. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIG_ID}/actions/${ACTION_ID}
optional id = 2
The resource ID components that identify the Action. They must match the resource name after proper encoding.
optional status_attributes = 3
The status of the action.
optional timing = 4
The timing of the whole action. For TestActions, the start time may be before the test actually started, and the duration may last until after the test actually finished.
oneof action_type
The type of the action. The type of an action may not change over the lifetime of the invocation. If one of these fields is to be set, it must be set in the CreateAction method. It may be set to an empty message that is populated in later methods or post-processing. A generic "untyped" action can be created by not setting any of these fields. An untyped action will be untyped for the lifetime of the invocation.
build_action = 9
Used only when this action represents a build action.
test_action = 10
Only for test actions.
optional action_attributes = 5
General attributes of the action.
repeated action_dependencies = 14
A list of resources that this action depended upon. May be used to provide the cause of a build failure in the case of a failed build action.
repeated properties = 7
Arbitrary name-value pairs. This is implemented as a multi-map. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 8
A list of file references for action level files. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID. Files with the following reserved file IDs cause specific post-processing or have special handling: For build actions: stdout: The stdout of the action stderr: The stderr of the action baseline.lcov: Baseline coverage file to be parsed by the server. This uses a stripped down implementation of the LCOV standard. http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php For test actions: test.xml: The test suite / test case data in XML format. test.log: The combined stdout and stderr of the test process. test.lcov: Coverage file to be parsed by the server. This uses a stripped down implementation of the LCOV standard. http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php
optional coverage = 11
Coverage data was collected while running the build or test action. This usually includes line coverage, and may also include branch coverage. For test actions, this is usually only for the source files which were actually executed by that particular action. For build actions, this is the baseline coverage, which captures the instrumented files and lines, without any lines being executed. This ensures files that are never covered at all are included.
repeated coverage_summaries = 12
Summary of aggregate coverage across all files for this action in. The server populates this for you in the post-processing phase.
repeated file_processing_errors = 13
ResultStore will read and parse Files with reserved IDs listed above. Read and parse errors for all these Files are reported here. This is implemented as a map, with one FileProcessingErrors for each file. Typically produced when parsing Files, but may also be provided directly by clients.
message
action.proto:39The resource ID components that identify the Action.
Used in:
string invocation_id = 1
The Invocation ID.
string target_id = 2
The Target ID.
string configuration_id = 3
The Configuration ID.
string action_id = 4
The Action ID.
message
action.proto:193General attributes of an action
Used in:
ExecutionStrategy execution_strategy = 1
Strategy used for executing the action.
int32 exit_code = 2
Exit code of the process that ran the action. A non-zero value means failure.
string hostname = 3
Where the action was run.
optional input_file_info = 4
Information about the input files used in all actions under this configured target.
message
coverage.proto:99Describes code coverage for a build or test Action. This is used to store baseline coverage for build Actions and test coverage for test Actions.
Used in:
repeated file_coverages = 2
List of coverage info for all source files that the TestResult covers.
message
file.proto:73Information specific to an entry in an archive.
Used in:
string path = 1
The relative path of the entry within the archive.
optional length = 2
(Optional) The uncompressed length of the archive entry in bytes. Allows the entry size to be shown in the UI. Omit if the length is not known.
string content_type = 3
(Optional) The content-type (aka MIME-type) of the archive entry. (e.g. text/plain, image/jpeg, text/html, etc). This is sent to the web browser so it knows how to handle the entry.
message
coverage.proto:50Describes branch coverage for a file
Used in:
bytes branch_present = 1
The field branch_present denotes the lines containing at least one branch. This is a bitfield where i-th bit corresponds to the i-th line. Divide line number by 8 to get index into byte array. Mod line number by 8 to get bit number (0 = LSB, 7 = MSB). A 1 denotes the line contains at least one branch. A 0 denotes the line contains no branches.
repeated int32 branches_in_line = 2
Contains the number of branches present, only for the lines which have the corresponding bit set in branch_present, in a relative order ignoring lines which do not have any branches.
bytes executed = 3
As each branch can have any one of the following three states: not executed, executed but not taken, executed and taken. This is a bitfield where i-th bit corresponds to the i-th line. Divide line number by 8 to get index into byte array. Mod line number by 8 to get bit number (0 = LSB, 7 = MSB). i-th bit of the following two byte arrays are used to denote the above mentioned states. not executed: i-th bit of executed == 0 && i-th bit of taken == 0 executed but not taken: i-th bit of executed == 1 && i-th bit of taken == 0 executed and taken: i-th bit of executed == 1 && i-th bit of taken == 1
bytes taken = 4
Described above.
message
coverage_summary.proto:40Summary of branch coverage A branch may be: * not executed. Counted only in total. * executed but not taken. Appears in total and executed. * executed and taken. Appears in all three fields.
Used in:
int32 total_branch_count = 1
The number of branches present in the file.
int32 executed_branch_count = 2
The number of branches executed out of the total branches present. A branch is executed when its condition is evaluated. This is <= total_branch_count as not all branches are executed.
int32 taken_branch_count = 3
The number of branches taken out of the total branches executed. A branch is taken when its condition is satisfied. This is <= executed_branch_count as not all executed branches are taken.
message
action.proto:138A build action, such as building a java library.
Used in:
string type = 1
The type of the action. This is intended to be a clue as to how the output of the action should be parsed. For example "javac" for a Java compile action.
string primary_input_path = 2
The "primary" input artifact processed by this action. E.g., the .cc file of a C++ compile action. Empty string ("") if the action has no input artifacts or no "primary" input artifact.
string primary_output_path = 3
The "primary" output artifact processed by this action. E.g., the .o file of a C++ compile action. Empty string ("") if the action has no output artifacts or no "primary" output artifact.
message
invocation.proto:101The command and arguments that produced this Invocation.
Used in:
string label = 1
A label describing this command line.
string tool = 2
The command-line tool that is run: argv[0].
repeated string args = 3
The arguments to the above tool: argv[1]...argv[N].
string command = 4
The actual command that was run with the tool. (e.g. "build", or "test") Omit if the tool doesn't accept a command. This is a duplicate of one of the fields in args.
message
configuration.proto:29Represents a configuration within an Invocation associated with one or more ConfiguredTargets. It captures the environment and other settings that were used.
Used as response type in: ResultStoreDownload.GetConfiguration
Used as field type in:
string name = 1
The format of this Configuration resource name must be: invocations/${INVOCATION_ID}/configs/${CONFIG_ID} The configuration ID of "default" should be preferred for the default configuration in a single-config invocation.
optional id = 2
The resource ID components that identify the Configuration. They must match the resource name after proper encoding.
optional status_attributes = 3
The aggregate status for this configuration.
optional configuration_attributes = 5
Attributes that apply only to this configuration.
repeated properties = 6
Arbitrary name-value pairs. This is implemented as a multi-map. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
message
configuration.proto:31The resource ID components that identify the Configuration.
Used in:
string invocation_id = 1
The Invocation ID.
string configuration_id = 2
The Configuration ID.
message
configuration.proto:62Attributes that apply only to the configuration.
Used in:
string cpu = 1
The type of cpu. (e.g. "x86", "powerpc")
message
configured_target.proto:34Each ConfiguredTarget represents data for a given configuration of a given target in a given Invocation. Every ConfiguredTarget should have at least one Action as a child resource before the invocation is finalized. Refer to the Action's documentation for more info on this.
Used as response type in: ResultStoreDownload.GetConfiguredTarget
Used as field type in:
string name = 1
The resource name. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIG_ID} where ${CONFIG_ID} must match the ID of an existing Configuration under this Invocation.
optional id = 2
The resource ID components that identify the ConfiguredTarget. They must match the resource name after proper encoding.
optional status_attributes = 3
The aggregate status for this configuration of this target. If testing was not requested, set this to the build status (e.g. BUILT or FAILED_TO_BUILD).
optional timing = 4
Captures the start time and duration of this configured target.
optional test_attributes = 6
Test specific attributes for this ConfiguredTarget.
repeated properties = 7
Arbitrary name-value pairs. This is implemented as a multi-map. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 8
A list of file references for configured target level files. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID.
repeated coverage_summaries = 9
Summary of aggregate coverage across all test actions for this target in this configuration. The server populates this for you in the post-processing phase.
message
configured_target.proto:36The resource ID components that identify the ConfiguredTarget.
Used in:
string invocation_id = 1
The Invocation ID.
string target_id = 2
The Target ID.
string configuration_id = 3
The Configuration ID.
message
configured_target.proto:85Attributes that apply only to test actions under this configured target.
Used in:
int32 total_run_count = 2
Total number of test runs. For example, in bazel this is specified with --runs_per_test. Zero if runs_per_test is not used.
int32 total_shard_count = 3
Total number of test shards. Zero if shard count was not specified.
optional timeout_duration = 5
How long test is allowed to run.
message
common.proto:59Represents a dependency of a resource on another resource. This can be used to define a graph or a workflow paradigm through resources.
Used in:
oneof resource
The resource depended upon. It may be a Target, ConfiguredTarget, or Action.
string target = 1
The name of a target. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID} This must point to an target under the same invocation.
string configured_target = 2
The name of a configured target. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIG_ID} This must point to an configured target under the same invocation.
string action = 3
The name of an action. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID}/configuredTargets/${CONFIG_ID}/actions/${ACTION_ID} This must point to an action under the same invocation.
string label = 4
A label describing this dependency. The label "Root Cause" is handled specially. It is used to point to the exact resource that caused a resource to fail.
Indicates how/where this Action was executed.
Used in:
EXECUTION_STRATEGY_UNSPECIFIED = 0
The action did not indicate how it was executed.
OTHER_ENVIRONMENT = 1
The action was executed in some other form.
REMOTE_SERVICE = 2
The action used a remote build service.
LOCAL_PARALLEL = 3
The action was executed locally, in parallel with other actions.
LOCAL_SEQUENTIAL = 4
The action was executed locally, without parallelism.
message
file.proto:27The metadata for a file or an archive file entry.
Used in: , , , , , ,
string uid = 1
The identifier of the file or archive entry. User-provided, must be unique for the repeated field it is in. When an Append RPC is called with a Files field populated, if a File already exists with this ID, that File will be overwritten with the new File proto.
string uri = 2
The URI of a file. This could also be the URI of an entire archive. Most log data doesn't need to be stored forever, so a ttl is suggested. Note that if you ever move or delete the file at this URI, the link from the server will be broken.
optional length = 3
(Optional) The length of the file in bytes. Allows the filesize to be shown in the UI. Omit if file is still being written or length is not known. This could also be the length of an entire archive.
string content_type = 4
(Optional) The content-type (aka MIME-type) of the file. This is sent to the web browser so it knows how to handle the file. (e.g. text/plain, image/jpeg, text/html, etc). For zip archives, use "application/zip".
optional archive_entry = 5
(Optional) If the above path, length, and content_type are referring to an archive, and you wish to refer to a particular entry within that archive, put the particular archive entry data here.
string content_viewer = 6
(Optional) A url to a content display app/site for this file or archive entry.
bool hidden = 7
(Optional) Whether to hide this file or archive entry in the UI. Defaults to false. A checkbox lets users see hidden files, but they're hidden by default.
string description = 8
(Optional) A short description of what this file or archive entry contains. This description should help someone viewing the list of these files to understand the purpose of this file and what they would want to view it for.
message
coverage.proto:86Describes code coverage for a particular file under test.
Used in:
string path = 1
Path of source file within the SourceContext of this Invocation.
optional line_coverage = 2
Details of lines in a file required to calculate line coverage.
optional branch_coverage = 3
Details of branches in a file required to calculate branch coverage.
message
action.proto:317Stores an error reading or parsing a file during post-processing.
Used in:
FileProcessingErrorType type = 1
The type of error that occurred.
string message = 2
Error message describing the problem.
Errors in file post-processing are categorized using this enum.
Used in:
FILE_PROCESSING_ERROR_TYPE_UNSPECIFIED = 0
Type unspecified or not listed here.
GENERIC_READ_ERROR = 1
A read error occurred trying to read the file.
GENERIC_PARSE_ERROR = 2
There was an error trying to parse the file.
FILE_TOO_LARGE = 3
File is exceeds size limit.
OUTPUT_TOO_LARGE = 4
The result of parsing the file exceeded size limit.
ACCESS_DENIED = 5
Read access to the file was denied by file system.
DEADLINE_EXCEEDED = 6
Deadline exceeded trying to read the file.
NOT_FOUND = 7
File not found.
message
action.proto:308Stores errors reading or parsing a file during post-processing.
Used in:
string file_uid = 1
The uid of the File being read or parsed.
repeated file_processing_errors = 3
What went wrong.
message
file_set.proto:27Represents a set of files within an Invocation. Can contain other file sets.
Used as response type in: ResultStoreDownload.GetFileSet
Used as field type in:
string name = 1
The format of this FileSet resource name must be: invocations/${INVOCATION_ID}/fileSets/${FILE_SET_ID}
optional id = 2
The resource ID components that identify the file set. They must match the resource name after proper encoding.
repeated string file_sets = 3
List of names of other file sets that are referenced from this one. Each name must point to a file set under the same invocation. The name format must be: invocations/${INVOCATION_ID}/fileSets/${FILE_SET_ID}
repeated files = 4
Files that are contained within this file set.
message
file_set.proto:29The resource ID components that identify the FileSet.
Used in:
string invocation_id = 1
The Invocation ID.
string file_set_id = 2
The FileSet ID.
message
action.proto:210File count and size information for the input files to a configured target.
Used in:
int64 count = 1
The number of input files (counting every file, even if a duplicate).
int64 distinct_count = 2
The number of distinct input files.
int64 count_limit = 3
The max number of input files allowed by the build system (counting every file, even if a duplicate).
int64 distinct_bytes = 4
The total size of the distinct input files.
int64 distinct_byte_limit = 5
The max allowed total size of the distinct input files.
message
invocation.proto:30An Invocation typically represents the result of running a tool. Each has a unique ID, typically generated by the server. Target resources under each Invocation contain the bulk of the data.
Used as response type in: ResultStoreDownload.GetInvocation
Used as field type in:
string name = 1
The resource name. Its format must be: invocations/${INVOCATION_ID}
optional id = 2
The resource ID components that identify the Invocation. They must match the resource name after proper encoding.
optional status_attributes = 3
The aggregate status of the invocation.
optional timing = 4
When this invocation started and its duration.
optional invocation_attributes = 5
Attributes of this invocation.
optional workspace_info = 6
The workspace the tool was run in.
repeated properties = 7
Arbitrary name-value pairs. This is implemented as a multi-map. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 8
A list of file references for invocation level files. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID. Use this field to specify build logs, and other invocation level logs.
repeated coverage_summaries = 9
Summary of aggregate coverage across all Actions in this Invocation. the server populates this for you in the post-processing phase.
message
invocation.proto:32The resource ID components that identify the Invocation.
Used in:
string invocation_id = 1
The Invocation ID.
message
invocation.proto:118Attributes that apply to all invocations.
Used in:
string project_id = 1
The project ID this invocation is associated with. This must be set in the CreateInvocation call, and can't be changed.
repeated string users = 2
The list of users in the command chain. The first user in this sequence is the one who instigated the first command in the chain.
repeated string labels = 3
Labels to categorize this invocation. This is implemented as a set. All labels will be unique. Any duplicate labels added will be ignored. Labels will be returned in lexicographical order. Labels should be short, easy to read, and you shouldn't have more than a handful. Labels should match regex \w([- \w]*\w)? Labels should not be used for unique properties such as unique IDs. Use properties in cases that don't meet these conditions.
These correspond to the prefix of the rule name. Eg cc_test has language CC.
Used in: ,
LANGUAGE_UNSPECIFIED = 0
Language unspecified or not listed here.
NONE = 1
Not related to any particular language
ANDROID = 2
Android
AS = 3
ActionScript (Flash)
CC = 4
C++ or C
CSS = 5
Cascading-Style-Sheets
DART = 6
Dart
GO = 7
Go
GWT = 8
Google-Web-Toolkit
HASKELL = 9
Haskell
JAVA = 10
Java
JS = 11
Javascript
LISP = 12
Lisp
OBJC = 13
Objective-C
PY = 14
Python
SH = 15
Shell (Typically Bash)
SWIFT = 16
Swift
TS = 18
Typescript
WEB = 19
Webtesting
message
coverage_summary.proto:56Summary of coverage in each language
Used in: , ,
Language language = 1
This summary is for all files written in this programming language.
optional line_summary = 2
Summary of lines covered vs instrumented.
optional branch_summary = 3
Summary of branch coverage.
message
coverage.proto:25Describes line coverage for a file
Used in:
bytes instrumented_lines = 1
Which source lines in the file represent the start of a statement that was instrumented to detect whether it was executed by the test. This is a bitfield where i-th bit corresponds to the i-th line. Divide line number by 8 to get index into byte array. Mod line number by 8 to get bit number (0 = LSB, 7 = MSB). A 1 denotes the line was instrumented. A 0 denotes the line was not instrumented.
bytes executed_lines = 2
Which of the instrumented source lines were executed by the test. Should include lines that were not instrumented. This is a bitfield where i-th bit corresponds to the i-th line. Divide line number by 8 to get index into byte array. Mod line number by 8 to get bit number (0 = LSB, 7 = MSB). A 1 denotes the line was executed. A 0 denotes the line was not executed.
message
coverage_summary.proto:27Summary of line coverage
Used in:
int32 instrumented_line_count = 1
Number of lines instrumented for coverage.
int32 executed_line_count = 2
Number of instrumented lines that were executed by the test.
message
action.proto:229Timing data for tests executed locally on the machine running the build.
Used in:
optional test_process_duration = 1
Time taken by the test process, typically surrounded by a small wrapper script.
message
common.proto:39A generic key-value property definition.
Used in: , , , , , ,
string key = 1
The key.
string value = 2
The value.
message
action.proto:236Timing data for one attempt to execute a test action remotely.
Used in:
optional queue_duration = 1
Idle period before the test process is invoked on the remote machine.
optional upload_duration = 2
Time to upload data dependencies from the local machine to the remote machine running the test, or to the distributed cache.
optional machine_setup_duration = 3
Time to set up the remote machine. Not to be confused with setup time in xUnit test frameworks, which falls within the test_process_time.
optional test_process_duration = 4
Time taken by the test process, typically surrounded by a small wrapper script. For Java tests, this includes JVM setup, flag parsing, class path setup, parsing files to setup the suite, and finally running your test methods. In many cases, only a small fraction of the test process time is spent running the test methods.
optional download_duration = 5
Time spent retrieving test logs and any other test outputs, back to the local machine.
message
action.proto:263Timing data for the part of the test execution that is done remotely.
Used in:
optional local_analysis_duration = 1
Time taken locally to determine what to do.
repeated attempts = 2
Normally there is only one attempt, but the system may retry on internal errors, leading to multiple attempts.
Status of a resource.
Used in:
STATUS_UNSPECIFIED = 0
The implicit default enum value. Should never be set.
BUILDING = 1
Displays as "Building". Means the target is compiling, linking, etc.
BUILT = 2
Displays as "Built". Means the target was built successfully. If testing was requested, it should never reach this status: it should go straight from BUILDING to TESTING.
FAILED_TO_BUILD = 3
Displays as "Broken". Means build failure such as compile error.
TESTING = 4
Displays as "Testing". Means the test is running.
PASSED = 5
Displays as "Passed". Means the test was run and passed.
FAILED = 6
Displays as "Failed". Means the test was run and failed.
TIMED_OUT = 7
Displays as "Timed out". Means the test didn't finish in time.
CANCELLED = 8
Displays as "Cancelled". Means the build or test was cancelled. E.g. User hit control-C.
TOOL_FAILED = 9
Displays as "Tool Failed". Means the build or test had internal tool failure.
INCOMPLETE = 10
Displays as "Incomplete". Means the build or test did not complete. This might happen when a build breakage or test failure causes the tool to stop trying to build anything more or run any more tests, with the default bazel --nokeep_going option or the --notest_keep_going option.
FLAKY = 11
Displays as "Flaky". Means the aggregate status contains some runs that were successful, and some that were not.
UNKNOWN = 12
Displays as "Unknown". Means the tool uploading to the server died mid-upload or does not know the state.
SKIPPED = 13
Displays as "Skipped". Means building and testing were skipped. (E.g. Restricted to a different configuration.)
message
common.proto:30Describes the status of a resource in both enum and string form. Only use description when conveying additional info not captured in the enum name.
Used in: , , , ,
Status status = 1
Enum representation of the status.
string description = 2
A longer description about the status.
message
target.proto:30Each Target represents data for a given target in a given Invocation. ConfiguredTarget and Action resources under each Target contain the bulk of the data.
Used as response type in: ResultStoreDownload.GetTarget
Used as field type in:
string name = 1
The resource name. Its format must be: invocations/${INVOCATION_ID}/targets/${TARGET_ID}
optional id = 2
The resource ID components that identify the Target. They must match the resource name after proper encoding.
optional status_attributes = 3
This is the aggregate status of the target.
optional timing = 4
When this target started and its duration.
optional target_attributes = 5
Attributes that apply to all targets.
optional test_attributes = 6
Attributes that apply to all test actions under this target.
repeated properties = 7
Arbitrary name-value pairs. This is implemented as a multi-map. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 8
A list of file references for target level files. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID. Use this field to specify outputs not related to a configuration.
bool is_visible = 9
Provides a hint to clients as to whether to display the Target to users. If true then clients likely want to display the Target by default. Once set to true, this may not be set back to false.
message
target.proto:32The resource ID components that identify the Target.
Used in:
string invocation_id = 1
The Invocation ID.
string target_id = 2
The Target ID.
message
target.proto:78Attributes that apply to all targets.
Used in:
TargetType type = 1
If known, indicates the type of this target. In bazel this corresponds to the rule-suffix.
Language language = 2
If known, the main language of this target, e.g. java, cc, python, etc.
repeated string tags = 3
The tags attribute of the build rule. These should be short, descriptive words, and there should only be a few of them. This is implemented as a set. All tags will be unique. Any duplicate tags will be ignored. Tags will be returned in lexicographical order.
These correspond to the suffix of the rule name. Eg cc_test has type TEST.
Used in:
TARGET_TYPE_UNSPECIFIED = 0
Unspecified by the build system.
APPLICATION = 1
An application e.g. ios_application.
BINARY = 2
A binary target e.g. cc_binary.
LIBRARY = 3
A library target e.g. java_library
PACKAGE = 4
A package
TEST = 5
Any test target, in bazel that means a rule with a '_test' suffix.
message
test_suite.proto:64The result of running a test case or test suite. JUnit3 TestDecorators are represented as a TestSuite with a single test.
Used in:
oneof test_type
Either a TestCase of a TestSuite
test_case = 1
When this contains just a single TestCase
test_suite = 2
When this contains a TestSuite of test cases.
message
action.proto:156A test action, such as running a JUnit4 test binary.
Used in:
optional test_timing = 1
Timing data for execution of the test action.
int32 shard_number = 2
If the test is divided up into shards to improve performance, set this to indicate which shard this test action is for. Value must be in interval [0, total_shard_count). Defaults to 0, which is appropriate if all test cases are run in the same process.
int32 run_number = 3
If the user requested that every test be run multiple times, as is often done to measure flakiness, set this to indicate which run this test action is for. Value must be in interval [0, total_run_count). Defaults to 0, which is appropriate if multiple runs were not requested.
int32 attempt_number = 4
If flaky tests are automatically retried, set this to indicate which attempt this test action is for. (e.g. 0 for the first attempt, 1 for second, and so on). Defaults to 0, which is appropriate if this is only attempt.
optional test_suite = 5
A tree of test suites and test cases that were run by this test action. Each test case has its own status information, including stack traces. Typically produced by parsing an XML Log, but may also be provided directly by clients.
repeated warnings = 8
Warnings for this test action.
int64 estimated_memory_bytes = 10
Estimated memory consumption of the test action, in bytes. A default value of 0 means there is no memory consumption estimate specified.
message
target.proto:94Attributes that apply only to test actions under this target.
Used in:
TestSize size = 1
Indicates how big the user indicated the test action was.
Most build systems cache build results to speed up incremental builds. Some also cache test results too. This indicates whether the test results were found in a cache, and where that cache was located.
Used in:
TEST_CACHING_UNSPECIFIED = 0
The implicit default enum value. Should never be set.
LOCAL_CACHE_HIT = 1
The test result was found in a local cache, so it wasn't run again.
REMOTE_CACHE_HIT = 2
The test result was found in a remote cache, so it wasn't run again.
CACHE_MISS = 3
The test result was not found in any cache, so it had to be run again.
message
test_suite.proto:77The result of running a test case, as reported in a <testcase> element of an XML log.
Used in:
string case_name = 1
The name of the test case, as reported in the name attribute. For Java, this is normally the method name. Eg. "testBasic".
string class_name = 2
The name of the class in which the test case was defined, as reported in the classname attribute. For Java, this is normally the fully qualified class name. Eg. "com.google.common.hash.BloomFilterTest".
TestCase.Result result = 3
An enum reported in the result attribute that is used in conjunction with failures and errors below to report the outcome.
repeated failures = 4
Failures reported in <failure> elements within this <testcase>.
repeated errors = 5
Errors reported in <error> elements within this <testcase>.
optional timing = 7
The timing for the TestCase, as reported by the time attribute.
repeated properties = 8
Arbitrary name-value pairs, as reported in custom attributes or in a <properties> element within this <testcase>. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 9
Files produced by this test case, as reported by undeclared output annotations. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID.
The result of running a test case.
Used in:
RESULT_UNSPECIFIED = 0
The implicit default enum value. Do not use.
COMPLETED = 1
Test case ran to completion. Look for failures or errors to determine whether it passed, failed, or errored.
INTERRUPTED = 2
Test case started but did not complete because the test harness received a signal and decided to stop running tests.
CANCELLED = 3
Test case was not started because the test harness received a SIGINT or timed out.
FILTERED = 4
Test case was not run because the user or process running the test specified a filter that excluded this test case.
SKIPPED = 5
Test case was not run to completion because the test case decided it should not be run (eg. due to a failed assumption in a JUnit4 test). Per-test setup or tear-down may or may not have run.
SUPPRESSED = 6
The test framework did not run the test case because it was labeled as suppressed. Eg. if someone temporarily disables a failing test.
message
test_suite.proto:168Represents an exception that prevented a test case from completing, as reported in an <error> element within a <testcase>. For Java, multiple TestErrors are used to represent a chained exception.
Used in: ,
string error_message = 1
The exception message, as reported in the message attribute. Typically short, but may be multi-line. Eg. "argument cannot be null".
string exception_type = 2
The type of the exception being thrown, reported in the type attribute. For Java, this is a fully qualified Throwable class name. Eg: "java.lang.IllegalArgumentException"
string stack_trace = 3
The stack trace reported as the content of the <error> element, often in a CDATA block. This contains one line for each stack frame, each including a method/function name, a class/file name, and a line number. Most recent call is usually first, but not for Python stack traces. May contain the exception_type and message.
message
test_suite.proto:148Represents a violated assertion, as reported in a <failure> element within a <testcase>. Some languages allow assertions to be made without stopping the test case when they're violated, leading to multiple TestFailures. For Java, multiple TestFailures are used to represent a chained exception.
Used in: ,
string failure_message = 1
The exception message reported in the message attribute. Typically short, but may be multi-line. Eg. "Expected 'foo' but was 'bar'".
string exception_type = 2
The type of the exception being thrown, reported in the type attribute. Eg: "org.junit.ComparisonFailure"
string stack_trace = 3
The stack trace reported as the content of the <failure> element, often in a CDATA block. This contains one line for each stack frame, each including a method/function name, a class/file name, and a line number. Most recent call is usually first, but not for Python stack traces. May contain the exception_type and message.
Indicates how big the user indicated the test action was.
Used in:
TEST_SIZE_UNSPECIFIED = 0
Unspecified by the user.
SMALL = 1
Unit test taking less than 1 minute.
MEDIUM = 2
Integration tests taking less than 5 minutes.
LARGE = 3
End-to-end tests taking less than 15 minutes.
ENORMOUS = 4
Even bigger than LARGE.
OTHER_SIZE = 5
Something that doesn't fit into the above categories.
message
test_suite.proto:29The result of running a test suite, as reported in a <testsuite> element of an XML log.
Used in: ,
string suite_name = 1
The full name of this suite, as reported in the name attribute. For Java tests, this is normally the fully qualified class name. Eg. "com.google.common.hash.BloomFilterTest".
repeated tests = 2
The results of the test cases and test suites contained in this suite, as reported in the <testcase> and <testsuite> elements contained within this <testsuite>.
repeated failures = 3
Failures reported in <failure> elements within this <testsuite>.
repeated errors = 4
Errors reported in <error> elements within this <testsuite>.
optional timing = 6
The timing for the entire TestSuite, as reported by the time attribute.
repeated properties = 7
Arbitrary name-value pairs, as reported in custom attributes or in a <properties> element within this <testsuite>. Multiple properties are allowed with the same key. Properties will be returned in lexicographical order by key.
repeated files = 8
Files produced by this test suite, as reported by undeclared output annotations. The file IDs must be unique within this list. Duplicate file IDs will result in an error. Files will be returned in lexicographical order by ID.
message
action.proto:274Timing data for execution of a test action. The action may be performed locally, on the machine running the build, or remotely.
Used in:
oneof location
Test timing for either a local or remote execution.
local = 1
Used for local test actions.
remote = 2
Used for remote test actions.
optional system_time_duration = 3
The amount of CPU time spent by the test process executing system calls within the kernel, as opposed to library code. Time the test process spent blocked does not count towards this figure.
optional user_time_duration = 4
The amount of CPU time spent by the test process executing user-mode code outside the kernel, as opposed to library code. Time the test process spent blocked does not count towards this figure. You can add user_time to system_time to get total CPU time taken by the test process.
TestCaching test_caching = 5
Most build systems cache build results to speed up incremental builds. Some also cache test results too. This indicates whether the test results were found in a cache, and where that cache was located.
message
action.proto:302A warning from a test execution.
Used in:
string warning_message = 1
Contains the message detailing the warning.
message
common.proto:49The timing of a particular Invocation, Action, etc. The start_time is specified, stop time can be calculated by adding duration to start_time.
Used in: , , , , ,
optional start_time = 1
The time the resource started running. This is in UTC Epoch time.
optional duration = 2
The duration for which the resource ran.
message
invocation.proto:74If known, represents the state of the user/build-system workspace.
Used in:
(message has no fields)
message
invocation.proto:81Describes the workspace under which the tool was invoked, this includes information that was fed into the command, the source code referenced, and the tool itself.
Used in:
optional workspace_context = 1
Data about the workspace that might be useful for debugging.
string hostname = 3
Where the tool was invoked
string working_directory = 4
The client's working directory where the build/test was run from.
string tool_tag = 5
Tools should set tool_tag to the name of the tool or use case.
repeated command_lines = 7
The command lines invoked. The first command line is the one typed by the user, then each one after that should be an expansion of the previous command line.