{ "mtlsRootUrl": "https://toolresults.mtls.googleapis.com/", "ownerDomain": "google.com", "description": "API to publish and access results from developer tools.", "documentationLink": "https://firebase.google.com/docs/test-lab/", "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "version": "v1beta3", "protocol": "rest", "id": "toolresults:v1beta3", "servicePath": "", "kind": "discovery#restDescription", "schemas": { "SuggestionProto": { "properties": { "region": { "description": "Region within the screenshot that is relevant to this suggestion. Optional.", "$ref": "RegionProto" }, "title": { "description": "General title for the suggestion, in the user's language, without markup. Always set.", "type": "string" }, "secondaryPriority": { "type": "number", "description": "Relative importance of a suggestion as compared with other suggestions that have the same priority and category. This is a meaningless value that can be used to order suggestions that are in the same category and have the same priority. The larger values have higher priority (i.e., are more important). Optional.", "format": "double" }, "longMessage": { "description": "Message, in the user's language, explaining the suggestion, which may contain markup. Always set.", "$ref": "SafeHtmlProto" }, "pseudoResourceId": { "description": "A somewhat human readable identifier of the source view, if it does not have a resource_name. This is a path within the accessibility hierarchy, an element with resource name; similar to an XPath.", "type": "string" }, "helpUrl": { "description": "Reference to a help center article concerning this type of suggestion. Always set.", "type": "string" }, "shortMessage": { "description": "Concise message, in the user's language, representing the suggestion, which may contain markup. Always set.", "$ref": "SafeHtmlProto" }, "screenId": { "description": "ID of the screen for the suggestion. It is used for getting the corresponding screenshot path. For example, screen_id \"1\" corresponds to \"1.png\" file in GCS. Always set.", "type": "string" }, "priority": { "enumDescriptions": [ "", "", "", "" ], "type": "string", "description": "Relative importance of a suggestion. Always set.", "enum": [ "unknownPriority", "error", "warning", "info" ] }, "resourceName": { "description": "Reference to a view element, identified by its resource name, if it has one.", "type": "string" } }, "type": "object", "id": "SuggestionProto" }, "ProjectSettings": { "properties": { "name": { "type": "string", "description": "The name of the project's settings. Always of the form: projects/{project-id}/settings In update request: never set In response: always set" }, "defaultBucket": { "type": "string", "description": "The name of the Google Cloud Storage bucket to which results are written. By default, this is unset. In update request: optional In response: optional" } }, "id": "ProjectSettings", "description": "Per-project settings for the Tool Results service.", "type": "object" }, "MultiStep": { "id": "MultiStep", "description": "Details when multiple steps are run with the same configuration as a group.", "type": "object", "properties": { "primaryStepId": { "description": "Step Id of the primary (original) step, which might be this step.", "type": "string" }, "primaryStep": { "description": "Present if it is a primary (original) step.", "$ref": "PrimaryStep" }, "multistepNumber": { "description": "Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0.", "format": "int32", "type": "integer" } } }, "LogcatCollectionError": { "id": "LogcatCollectionError", "description": "A warning that there were issues in logcat collection.", "type": "object", "properties": {} }, "IosTest": { "properties": { "iosRoboTest": { "description": "An iOS Robo test.", "$ref": "IosRoboTest" }, "iosAppInfo": { "description": "Information about the application under test.", "$ref": "IosAppInfo" }, "iosTestLoop": { "description": "An iOS test loop.", "$ref": "IosTestLoop" }, "testTimeout": { "description": "Max time a test is allowed to run before it is automatically cancelled.", "$ref": "Duration" }, "iosXcTest": { "description": "An iOS XCTest.", "$ref": "IosXcTest" } }, "type": "object", "id": "IosTest", "description": "A iOS mobile test specification" }, "TestTiming": { "properties": { "testProcessDuration": { "description": "How long it took to run the test process. - In response: present if previously set. - In create/update request: optional", "$ref": "Duration" } }, "type": "object", "id": "TestTiming", "description": "Testing timing break down to know phases." }, "NonSdkApiUsageViolation": { "type": "object", "id": "NonSdkApiUsageViolation", "description": "Additional details for a non-sdk API usage violation.", "properties": { "uniqueApis": { "description": "Total number of unique hidden API's accessed.", "format": "int32", "type": "integer" }, "apiSignatures": { "description": "Signatures of a subset of those hidden API's.", "type": "array", "items": { "type": "string" } } } }, "TestCase": { "properties": { "skippedMessage": { "type": "string", "description": "Why the test case was skipped. Present only for skipped test case" }, "testCaseReference": { "description": "Test case reference, e.g. name, class name and test suite name. Required.", "$ref": "TestCaseReference" }, "toolOutputs": { "description": "References to opaque files of any format output by the tool execution. @OutputOnly", "type": "array", "items": { "$ref": "ToolOutputReference" } }, "endTime": { "description": "The end time of the test case.", "$ref": "Timestamp" }, "testCaseId": { "type": "string", "description": "A unique identifier within a Step for this Test Case." }, "status": { "description": "The status of the test case. Required.", "enum": [ "passed", "failed", "error", "skipped", "flaky" ], "type": "string", "enumDescriptions": [ "Test passed.", "Test failed.", "Test encountered an error", "Test skipped", "Test flaked. Present only for rollup test cases; test cases from steps that were run with the same configuration had both failure and success outcomes." ] }, "startTime": { "description": "The start time of the test case.", "$ref": "Timestamp" }, "stackTraces": { "description": "The stack trace details if the test case failed or encountered an error. The maximum size of the stack traces is 100KiB, beyond which the stack track will be truncated. Zero if the test case passed.", "type": "array", "items": { "$ref": "StackTrace" } }, "elapsedTime": { "description": "The elapsed run time of the test case. Required.", "$ref": "Duration" } }, "type": "object", "id": "TestCase" }, "RegionProto": { "properties": { "heightPx": { "description": "The height, in pixels. Always set.", "format": "int32", "type": "integer" }, "widthPx": { "description": "The width, in pixels. Always set.", "format": "int32", "type": "integer" }, "topPx": { "type": "integer", "description": "The top of the rectangle, in pixels. Always set.", "format": "int32" }, "leftPx": { "description": "The left side of the rectangle, in pixels. Always set.", "format": "int32", "type": "integer" } }, "id": "RegionProto", "description": "A rectangular region.", "type": "object" }, "ToolExecutionStep": { "type": "object", "id": "ToolExecutionStep", "description": "Generic tool step to be used for binaries we do not explicitly support. For example: running cp to copy artifacts from one location to another.", "properties": { "toolExecution": { "description": "A Tool execution. - In response: present if set by create/update request - In create/update request: optional", "$ref": "ToolExecution" } } }, "CPUInfo": { "properties": { "cpuSpeedInGhz": { "description": "the CPU clock speed in GHz", "format": "float", "type": "number" }, "numberOfCores": { "type": "integer", "description": "the number of CPU cores", "format": "int32" }, "cpuProcessor": { "type": "string", "description": "description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A'" } }, "type": "object", "id": "CPUInfo" }, "TestExecutionStep": { "properties": { "toolExecution": { "description": "Represents the execution of the test runner. The exit code of this tool will be used to determine if the test passed. - In response: always set - In create/update request: optional", "$ref": "ToolExecution" }, "testSuiteOverviews": { "type": "array", "items": { "$ref": "TestSuiteOverview" }, "description": "List of test suite overview contents. This could be parsed from xUnit XML log by server, or uploaded directly by user. This references should only be called when test suites are fully parsed or uploaded. The maximum allowed number of test suite overviews per step is 1000. - In response: always set - In create request: optional - In update request: never (use publishXunitXmlFiles custom method instead)" }, "testIssues": { "description": "Issues observed during the test execution. For example, if the mobile app under test crashed during the test, the error message and the stack trace content can be recorded here to assist debugging. - In response: present if set by create or update - In create/update request: optional", "type": "array", "items": { "$ref": "TestIssue" } }, "testTiming": { "description": "The timing break down of the test execution. - In response: present if set by create or update - In create/update request: optional", "$ref": "TestTiming" } }, "id": "TestExecutionStep", "description": "A step that represents running tests. It accepts ant-junit xml files which will be parsed into structured test results by the service. Xml file paths are updated in order to append more files, however they can't be deleted. Users can also add test results manually by using the test_result field.", "type": "object" }, "NonSdkApiInsight": { "properties": { "pendingGoogleUpdateInsight": { "description": "An insight indicating that the hidden API usage originates from a Google-provided library.", "$ref": "PendingGoogleUpdateInsight" }, "matcherId": { "description": "A unique ID, to be used for determining the effectiveness of this particular insight in the context of a matcher. (required)", "type": "string" }, "exampleTraceMessages": { "type": "array", "items": { "type": "string" }, "description": "Optional sample stack traces, for which this insight applies (there should be at least one)." }, "upgradeInsight": { "description": "An insight indicating that the hidden API usage originates from the use of a library that needs to be upgraded.", "$ref": "UpgradeInsight" } }, "type": "object", "id": "NonSdkApiInsight", "description": "Non-SDK API insights (to address debugging solutions)." }, "TestCaseReference": { "properties": { "className": { "description": "The name of the class.", "type": "string" }, "name": { "type": "string", "description": "The name of the test case. Required." }, "testSuiteName": { "type": "string", "description": "The name of the test suite to which this test case belongs." } }, "type": "object", "id": "TestCaseReference", "description": "A reference to a test case. Test case references are canonically ordered lexicographically by these three factors: * First, by test_suite_name. * Second, by class_name. * Third, by name." }, "EncounteredLoginScreen": { "properties": { "screenIds": { "description": "Subset of login screens.", "type": "array", "items": { "type": "string" } }, "distinctScreens": { "description": "Number of encountered distinct login screens.", "format": "int32", "type": "integer" } }, "type": "object", "id": "EncounteredLoginScreen", "description": "Additional details about encountered login screens." }, "Timestamp": { "properties": { "seconds": { "type": "string", "description": "Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.", "format": "int64" }, "nanos": { "type": "integer", "description": "Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive.", "format": "int32" } }, "type": "object", "id": "Timestamp", "description": "A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one. All minutes are 60 seconds long. Leap seconds are \"smeared\" so that no leap second table is needed for interpretation, using a [24-hour linear smear](https://developers.google.com/time/smear). The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By restricting to that range, we ensure that we can convert to and from [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings." }, "NonSdkApi": { "properties": { "invocationCount": { "type": "integer", "description": "The total number of times this API was observed to have been called.", "format": "int32" }, "exampleStackTraces": { "description": "Example stack traces of this API being called.", "type": "array", "items": { "type": "string" } }, "apiSignature": { "description": "The signature of the Non-SDK API", "type": "string" }, "insights": { "description": "Optional debugging insights for non-SDK API violations.", "type": "array", "items": { "$ref": "NonSdkApiInsight" } }, "list": { "description": "Which list this API appears on", "enum": [ "NONE", "WHITE", "BLACK", "GREY", "GREY_MAX_O", "GREY_MAX_P", "GREY_MAX_Q", "GREY_MAX_R", "GREY_MAX_S" ], "type": "string", "enumDescriptions": [ "", "", "", "", "", "", "", "", "" ], "deprecated": true } }, "type": "object", "id": "NonSdkApi", "description": "A non-sdk API and examples of it being called along with other metadata See https://developer.android.com/distribute/best-practices/develop/restrictions-non-sdk-interfaces" }, "MergedResult": { "type": "object", "id": "MergedResult", "description": "Merged test result for environment. If the environment has only one step (no reruns or shards), then the merged result is the same as the step result. If the environment has multiple shards and/or reruns, then the results of shards and reruns that belong to the same environment are merged into one environment result.", "properties": { "outcome": { "description": "Outcome of the resource", "$ref": "Outcome" }, "testSuiteOverviews": { "type": "array", "items": { "$ref": "TestSuiteOverview" }, "description": "The combined and rolled-up result of each test suite that was run as part of this environment. Combining: When the test cases from a suite are run in different steps (sharding), the results are added back together in one overview. (e.g., if shard1 has 2 failures and shard2 has 1 failure than the overview failure_count = 3). Rollup: When test cases from the same suite are run multiple times (flaky), the results are combined (e.g., if testcase1.run1 fails, testcase1.run2 passes, and both testcase2.run1 and testcase2.run2 fail then the overview flaky_count = 1 and failure_count = 1)." }, "state": { "description": "State of the resource", "enum": [ "unknownState", "pending", "inProgress", "complete" ], "type": "string", "enumDescriptions": [ "Should never be in this state. Exists for proto deserialization backward compatibility.", "The Execution/Step is created, ready to run, but not running yet. If an Execution/Step is created without initial state, it is assumed that the Execution/Step is in PENDING state.", "The Execution/Step is in progress.", "The finalized, immutable state. Steps/Executions in this state cannot be modified." ] } } }, "PrimaryStep": { "properties": { "rollUp": { "description": "Rollup test status of multiple steps that were run with the same configuration as a group.", "enum": [ "unset", "success", "failure", "inconclusive", "skipped", "flaky" ], "type": "string", "enumDescriptions": [ "Do not use. For proto versioning only.", "The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test.", "A run failed, for instance: - One or more test case failed. - A test timed out. - The application under test crashed.", "Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful.", "All tests were skipped, for instance: - All device configurations were incompatible.", "A group of steps that were run with the same configuration had both failure and success outcomes." ] }, "individualOutcome": { "type": "array", "items": { "$ref": "IndividualOutcome" }, "description": "Step Id and outcome of each individual step." } }, "type": "object", "id": "PrimaryStep", "description": "Stores rollup test status of multiple steps that were run as a group and outcome of each individual step." }, "OverlappingUIElements": { "id": "OverlappingUIElements", "description": "A warning that Robo encountered a screen that has overlapping clickable elements; this may indicate a potential UI issue.", "type": "object", "properties": { "screenId": { "description": "The screen id of the elements", "type": "string" }, "resourceName": { "description": "Resource names of the overlapping screen elements", "type": "array", "items": { "type": "string" } } } }, "Image": { "properties": { "stepId": { "type": "string", "description": "The step to which the image is attached. Always set." }, "thumbnail": { "description": "The thumbnail.", "$ref": "Thumbnail" }, "sourceImage": { "description": "A reference to the full-size, original image. This is the same as the tool_outputs entry for the image under its Step. Always set.", "$ref": "ToolOutputReference" }, "error": { "description": "An error explaining why the thumbnail could not be rendered.", "$ref": "Status" } }, "type": "object", "id": "Image", "description": "An image, with a link to the main image and a thumbnail." }, "ListScreenshotClustersResponse": { "id": "ListScreenshotClustersResponse", "type": "object", "properties": { "clusters": { "description": "The set of clusters associated with an execution Always set", "type": "array", "items": { "$ref": "ScreenshotCluster" } } } }, "AppStartTime": { "properties": { "fullyDrawnTime": { "description": "Optional. The time from app start to reaching the developer-reported \"fully drawn\" time. This is only stored if the app includes a call to Activity.reportFullyDrawn(). See https://developer.android.com/topic/performance/launch-time.html#time-full", "$ref": "Duration" }, "initialDisplayTime": { "description": "The time from app start to the first displayed activity being drawn, as reported in Logcat. See https://developer.android.com/topic/performance/launch-time.html#time-initial", "$ref": "Duration" } }, "type": "object", "id": "AppStartTime" }, "PerfSampleSeries": { "properties": { "historyId": { "type": "string", "description": "A tool results history ID. @OutputOnly" }, "sampleSeriesId": { "description": "A sample series id @OutputOnly", "type": "string" }, "stepId": { "type": "string", "description": "A tool results step ID. @OutputOnly" }, "projectId": { "type": "string", "description": "The cloud project @OutputOnly" }, "executionId": { "type": "string", "description": "A tool results execution ID. @OutputOnly" }, "basicPerfSampleSeries": { "description": "Basic series represented by a line chart", "$ref": "BasicPerfSampleSeries" } }, "id": "PerfSampleSeries", "description": "Resource representing a collection of performance samples (or data points)", "type": "object" }, "UsedRoboDirective": { "properties": { "resourceName": { "description": "The name of the resource that was used.", "type": "string" } }, "type": "object", "id": "UsedRoboDirective", "description": "Additional details of a used Robo directive." }, "Status": { "properties": { "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, "details": { "type": "array", "items": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use." } }, "id": "Status", "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "type": "object" }, "Screen": { "properties": { "fileReference": { "description": "File reference of the png file. Required.", "type": "string" }, "version": { "description": "OS version of the device that the screenshot was taken on. Required.", "type": "string" }, "model": { "type": "string", "description": "Model of the device that the screenshot was taken on. Required." }, "locale": { "description": "Locale of the device that the screenshot was taken on. Required.", "type": "string" } }, "id": "Screen", "type": "object" }, "AndroidTest": { "type": "object", "id": "AndroidTest", "description": "An Android mobile test specification.", "properties": { "androidInstrumentationTest": { "description": "An Android instrumentation test.", "$ref": "AndroidInstrumentationTest" }, "androidAppInfo": { "description": "Information about the application under test.", "$ref": "AndroidAppInfo" }, "androidRoboTest": { "description": "An Android robo test.", "$ref": "AndroidRoboTest" }, "androidTestLoop": { "description": "An Android test loop.", "$ref": "AndroidTestLoop" }, "testTimeout": { "description": "Max time a test is allowed to run before it is automatically cancelled.", "$ref": "Duration" } } }, "ShardSummary": { "properties": { "shardResult": { "description": "Merged result of the shard.", "$ref": "MergedResult" }, "runs": { "description": "Summaries of the steps belonging to the shard. With flaky_test_attempts enabled from TestExecutionService, more than one run (Step) can present. And the runs will be sorted by multistep_number.", "type": "array", "items": { "$ref": "StepSummary" } } }, "type": "object", "id": "ShardSummary", "description": "Result summary for a shard in an environment." }, "InsufficientCoverage": { "id": "InsufficientCoverage", "description": "A warning that Robo did not crawl potentially important parts of the app.", "type": "object", "properties": {} }, "IndividualOutcome": { "id": "IndividualOutcome", "description": "Step Id and outcome of each individual step that was run as a group with other steps with the same configuration.", "type": "object", "properties": { "outcomeSummary": { "enumDescriptions": [ "Do not use. For proto versioning only.", "The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test.", "A run failed, for instance: - One or more test case failed. - A test timed out. - The application under test crashed.", "Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful.", "All tests were skipped, for instance: - All device configurations were incompatible.", "A group of steps that were run with the same configuration had both failure and success outcomes." ], "enum": [ "unset", "success", "failure", "inconclusive", "skipped", "flaky" ], "type": "string" }, "multistepNumber": { "type": "integer", "description": "Unique int given to each step. Ranges from 0(inclusive) to total number of steps(exclusive). The primary step is 0.", "format": "int32" }, "runDuration": { "description": "How long it took for this step to run.", "$ref": "Duration" }, "stepId": { "type": "string" } } }, "DeviceOutOfMemory": { "type": "object", "id": "DeviceOutOfMemory", "description": "A warning that device ran out of memory", "properties": {} }, "SafeHtmlProto": { "type": "object", "id": "SafeHtmlProto", "description": "IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.", "properties": { "privateDoNotAccessOrElseSafeHtmlWrappedValue": { "description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", "type": "string" } } }, "ToolExecution": { "properties": { "commandLineArguments": { "type": "array", "items": { "type": "string" }, "description": "The full tokenized command line including the program name (equivalent to argv in a C program). - In response: present if set by create request - In create request: optional - In update request: never set" }, "exitCode": { "description": "Tool execution exit code. This field will be set once the tool has exited. - In response: present if set by create/update request - In create request: optional - In update request: optional, a FAILED_PRECONDITION error will be returned if an exit_code is already set.", "$ref": "ToolExitCode" }, "toolLogs": { "type": "array", "items": { "$ref": "FileReference" }, "description": "References to any plain text logs output the tool execution. This field can be set before the tool has exited in order to be able to have access to a live view of the logs while the tool is running. The maximum allowed number of tool logs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list" }, "toolOutputs": { "description": "References to opaque files of any format output by the tool execution. The maximum allowed number of tool outputs per step is 1000. - In response: present if set by create/update request - In create request: optional - In update request: optional, any value provided will be appended to the existing list", "type": "array", "items": { "$ref": "ToolOutputReference" } } }, "type": "object", "id": "ToolExecution", "description": "An execution of an arbitrary tool. It could be a test runner or a tool copying artifacts or deploying code." }, "NativeCrash": { "id": "NativeCrash", "description": "Additional details for a native crash.", "type": "object", "properties": { "stackTrace": { "description": "The stack trace of the native crash. Optional.", "$ref": "StackTrace" } } }, "IosXcTest": { "properties": { "bundleId": { "type": "string", "description": "Bundle ID of the app." }, "xcodeVersion": { "description": "Xcode version that the test was run with.", "type": "string" } }, "type": "object", "id": "IosXcTest", "description": "A test of an iOS application that uses the XCTest framework." }, "FailedToInstall": { "type": "object", "id": "FailedToInstall", "description": "Failed to install the App.", "properties": {} }, "FailureDetail": { "properties": { "otherNativeCrash": { "description": "If a native process (including any other than the app) crashed.", "type": "boolean" }, "unableToCrawl": { "type": "boolean", "description": "If the robo was unable to crawl the app; perhaps because the app did not start." }, "deviceOutOfMemory": { "description": "If the device ran out of memory during a test, causing the test to crash.", "type": "boolean" }, "crashed": { "type": "boolean", "description": "If the failure was severe because the system (app) under test crashed." }, "timedOut": { "type": "boolean", "description": "If the test overran some time limit, and that is why it failed." }, "failedRoboscript": { "type": "boolean", "description": "If the Roboscript failed to complete successfully, e.g., because a Roboscript action or assertion failed or a Roboscript action could not be matched during the entire crawl." }, "notInstalled": { "description": "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "type": "boolean" } }, "id": "FailureDetail", "description": "Details for an outcome with a FAILURE outcome summary.", "type": "object" }, "BasicPerfSampleSeries": { "id": "BasicPerfSampleSeries", "description": "Encapsulates the metadata for basic sample series represented by a line chart", "type": "object", "properties": { "perfUnit": { "enumDescriptions": [ "", "", "", "", "", "" ], "enum": [ "perfUnitUnspecified", "kibibyte", "percent", "bytesPerSecond", "framesPerSecond", "byte" ], "type": "string" }, "perfMetricType": { "enum": [ "perfMetricTypeUnspecified", "memory", "cpu", "network", "graphics" ], "type": "string", "enumDescriptions": [ "", "", "", "", "" ] }, "sampleSeriesLabel": { "type": "string", "enum": [ "sampleSeriesTypeUnspecified", "memoryRssPrivate", "memoryRssShared", "memoryRssTotal", "memoryTotal", "cpuUser", "cpuKernel", "cpuTotal", "ntBytesTransferred", "ntBytesReceived", "networkSent", "networkReceived", "graphicsFrameRate" ], "enumDescriptions": [ "", "Memory sample series", "", "", "", "CPU sample series", "", "", "Network sample series", "", "", "", "Graphics sample series" ] } } }, "BatchCreatePerfSamplesRequest": { "id": "BatchCreatePerfSamplesRequest", "description": "The request must provide up to a maximum of 5000 samples to be created; a larger sample size will cause an INVALID_ARGUMENT error", "type": "object", "properties": { "perfSamples": { "description": "The set of PerfSamples to create should not include existing timestamps", "type": "array", "items": { "$ref": "PerfSample" } } } }, "TestIssue": { "properties": { "warning_migration": { "description": "Warning message with additional details of the issue. Should always be a message from com.google.devtools.toolresults.v1.warnings", "$ref": "Any" }, "type": { "enumDescriptions": [ "Default unspecified type. Do not use. For versioning only.", "Issue is a fatal exception.", "Issue is a native crash.", "Issue is an ANR crash.", "Issue is an unused robo directive.", "Issue is a suggestion to use orchestrator.", "Issue with finding a launcher activity", "Issue with resolving a user-provided intent to start an activity", "A Robo script was not fully executed.", "A Robo script was fully and successfully executed.", "The APK failed to install.", "The app-under-test has deep links, but none were provided to Robo.", "App accessed a non-sdk Api.", "App accessed a non-sdk Api (new detailed report)", "Robo crawl encountered at least one screen with elements that are not Android UI widgets.", "Robo crawl encountered at least one probable login screen.", "Robo signed in with Google.", "iOS App crashed with an exception.", "iOS App crashed without an exception (e.g. killed).", "Robo crawl involved performing some monkey actions.", "Robo crawl used a Robo directive.", "Robo crawl used a Robo directive to ignore an UI element.", "Robo did not crawl some potentially important parts of the app.", "Robo crawl involved some in-app purchases.", "Crash dialog was detected during the test execution", "UI element depth is greater than the threshold", "Blank screen is found in the Robo crawl", "Overlapping UI elements are found in the Robo crawl", "An uncaught Unity exception was detected (these don't crash apps).", "Device running out of memory was detected", "Problems detected while collecting logcat", "Robo detected a splash screen provided by app (vs. Android OS splash screen).", "There was an issue with the assets in this test." ], "description": "Type of issue. Required.", "enum": [ "unspecifiedType", "fatalException", "nativeCrash", "anr", "unusedRoboDirective", "compatibleWithOrchestrator", "launcherActivityNotFound", "startActivityNotFound", "incompleteRoboScriptExecution", "completeRoboScriptExecution", "failedToInstall", "availableDeepLinks", "nonSdkApiUsageViolation", "nonSdkApiUsageReport", "encounteredNonAndroidUiWidgetScreen", "encounteredLoginScreen", "performedGoogleLogin", "iosException", "iosCrash", "performedMonkeyActions", "usedRoboDirective", "usedRoboIgnoreDirective", "insufficientCoverage", "inAppPurchases", "crashDialogError", "uiElementsTooDeep", "blankScreen", "overlappingUiElements", "unityException", "deviceOutOfMemory", "logcatCollectionError", "detectedAppSplashScreen", "assetIssue" ], "type": "string" }, "severity": { "type": "string", "description": "Severity of issue. Required.", "enum": [ "unspecifiedSeverity", "info", "suggestion", "warning", "severe" ], "enumDescriptions": [ "Default unspecified severity. Do not use. For versioning only.", "Non critical issue, providing users with some info about the test run.", "Non critical issue, providing users with some hints on improving their testing experience, e.g., suggesting to use Game Loops.", "Potentially critical issue.", "Critical issue." ] }, "errorMessage": { "description": "A brief human-readable message describing the issue. Required.", "type": "string" }, "stackTrace": { "description": "Deprecated in favor of stack trace fields inside specific warnings.", "$ref": "StackTrace", "deprecated": true }, "category": { "description": "Category of issue. Required.", "enum": [ "unspecifiedCategory", "common", "robo" ], "type": "string", "enumDescriptions": [ "Default unspecified category. Do not use. For versioning only.", "Issue is not specific to a particular test kind (e.g., a native crash).", "Issue is specific to Robo run." ] } }, "id": "TestIssue", "description": "An issue detected occurring during a test execution.", "type": "object" }, "AndroidRoboTest": { "type": "object", "id": "AndroidRoboTest", "description": "A test of an android application that explores the application on a virtual or physical Android device, finding culprits and crashes as it goes.", "properties": { "maxSteps": { "description": "The max number of steps/actions Robo can execute. Default is no limit (0). Optional", "format": "int32", "type": "integer" }, "bootstrapPackageId": { "description": "The java package for the bootstrap. Optional", "type": "string" }, "bootstrapRunnerClass": { "type": "string", "description": "The runner class for the bootstrap. Optional" }, "appInitialActivity": { "type": "string", "description": "The initial activity that should be used to start the app. Optional" }, "maxDepth": { "description": "The max depth of the traversal stack Robo can explore. Optional", "format": "int32", "type": "integer" } } }, "MatrixDimensionDefinition": { "id": "MatrixDimensionDefinition", "description": "One dimension of the matrix of different runs of a step.", "type": "object", "properties": {} }, "IosAppCrashed": { "properties": { "stackTrace": { "description": "The stack trace, if one is available. Optional.", "$ref": "StackTrace" } }, "type": "object", "id": "IosAppCrashed", "description": "Additional details for an iOS app crash." }, "AvailableDeepLinks": { "id": "AvailableDeepLinks", "description": "A suggestion to use deep links for a Robo run.", "type": "object", "properties": {} }, "AssetIssue": { "type": "object", "id": "AssetIssue", "description": "There was an issue with the assets in this test.", "properties": {} }, "Outcome": { "properties": { "summary": { "description": "The simplest way to interpret a result. Required", "enum": [ "unset", "success", "failure", "inconclusive", "skipped", "flaky" ], "type": "string", "enumDescriptions": [ "Do not use. For proto versioning only.", "The test matrix run was successful, for instance: - All the test cases passed. - Robo did not detect a crash of the application under test.", "A run failed, for instance: - One or more test case failed. - A test timed out. - The application under test crashed.", "Something unexpected happened. The run should still be considered unsuccessful but this is likely a transient problem and re-running the test might be successful.", "All tests were skipped, for instance: - All device configurations were incompatible.", "A group of steps that were run with the same configuration had both failure and success outcomes." ] }, "skippedDetail": { "description": "More information about a SKIPPED outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED. Optional", "$ref": "SkippedDetail" }, "successDetail": { "description": "More information about a SUCCESS outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS. Optional", "$ref": "SuccessDetail" }, "failureDetail": { "description": "More information about a FAILURE outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE. Optional", "$ref": "FailureDetail" }, "inconclusiveDetail": { "description": "More information about an INCONCLUSIVE outcome. Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE. Optional", "$ref": "InconclusiveDetail" } }, "type": "object", "id": "Outcome", "description": "Interprets a result so that humans and machines can act on it." }, "InAppPurchasesFound": { "type": "object", "id": "InAppPurchasesFound", "description": "Additional details of in-app purchases encountered during the crawl.", "properties": { "inAppPurchasesFlowsStarted": { "description": "The total number of in-app purchases flows started.", "format": "int32", "type": "integer" }, "inAppPurchasesFlowsExplored": { "type": "integer", "description": "The total number of in-app purchases flows explored: how many times the robo tries to buy a SKU.", "format": "int32" } } }, "StepLabelsEntry": { "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "type": "object", "id": "StepLabelsEntry" }, "SkippedDetail": { "properties": { "incompatibleDevice": { "type": "boolean", "description": "If the requested OS version doesn't run on the specific device model." }, "incompatibleAppVersion": { "type": "boolean", "description": "If the App doesn't support the specific API level." }, "pendingTimeout": { "description": "Indicates that the test could not be scheduled in the requested time because no suitable device was available.", "type": "boolean" }, "incompatibleArchitecture": { "description": "If the App doesn't run on the specific architecture, for example, x86.", "type": "boolean" } }, "id": "SkippedDetail", "description": "Details for an outcome with a SKIPPED outcome summary.", "type": "object" }, "BlankScreen": { "type": "object", "id": "BlankScreen", "description": "A warning that Robo encountered a screen that was mostly blank; this may indicate a problem with the app.", "properties": { "screenId": { "description": "The screen id of the element", "type": "string" } } }, "ListPerfSamplesResponse": { "properties": { "perfSamples": { "type": "array", "items": { "$ref": "PerfSample" } }, "nextPageToken": { "type": "string", "description": "Optional, returned if result size exceeds the page size specified in the request (or the default page size, 500, if unspecified). It indicates the last sample timestamp to be used as page_token in subsequent request" } }, "id": "ListPerfSamplesResponse", "type": "object" }, "RoboScriptExecution": { "properties": { "totalActions": { "description": "The total number of actions in the Robo script.", "format": "int32", "type": "integer" }, "successfulActions": { "type": "integer", "description": "The number of Robo script actions executed successfully.", "format": "int32" } }, "type": "object", "id": "RoboScriptExecution", "description": "Execution stats for a user-provided Robo script." }, "PublishXunitXmlFilesRequest": { "properties": { "xunitXmlFiles": { "description": "URI of the Xunit XML files to publish. The maximum size of the file this reference is pointing to is 50MB. Required.", "type": "array", "items": { "$ref": "FileReference" } } }, "id": "PublishXunitXmlFilesRequest", "description": "Request message for StepService.PublishXunitXmlFiles.", "type": "object" }, "ScreenshotCluster": { "properties": { "activity": { "type": "string", "description": "A string that describes the activity of every screen in the cluster." }, "clusterId": { "type": "string", "description": "A unique identifier for the cluster. @OutputOnly" }, "keyScreen": { "description": "A singular screen that represents the cluster as a whole. This screen will act as the \"cover\" of the entire cluster. When users look at the clusters, only the key screen from each cluster will be shown. Which screen is the key screen is determined by the ClusteringAlgorithm", "$ref": "Screen" }, "screens": { "description": "Full list of screens.", "type": "array", "items": { "$ref": "Screen" } } }, "id": "ScreenshotCluster", "type": "object" }, "CrashDialogError": { "type": "object", "id": "CrashDialogError", "description": "Crash dialog was detected during the test execution", "properties": { "crashPackage": { "description": "The name of the package that caused the dialog.", "type": "string" } } }, "PendingGoogleUpdateInsight": { "id": "PendingGoogleUpdateInsight", "description": "This insight indicates that the hidden API usage originates from a Google-provided library. Users need not take any action.", "type": "object", "properties": { "nameOfGoogleLibrary": { "type": "string", "description": "The name of the Google-provided library with the non-SDK API dependency." } } }, "UnusedRoboDirective": { "properties": { "resourceName": { "type": "string", "description": "The name of the resource that was unused." } }, "id": "UnusedRoboDirective", "description": "Additional details of an unused robodirective.", "type": "object" }, "EncounteredNonAndroidUiWidgetScreen": { "type": "object", "id": "EncounteredNonAndroidUiWidgetScreen", "description": "Additional details about encountered screens with elements that are not Android UI widgets.", "properties": { "screenIds": { "description": "Subset of screens which contain non Android UI widgets.", "type": "array", "items": { "type": "string" } }, "distinctScreens": { "description": "Number of encountered distinct screens with non Android UI widgets.", "format": "int32", "type": "integer" } } }, "NonSdkApiUsageViolationReport": { "id": "NonSdkApiUsageViolationReport", "description": "Contains a summary and examples of non-sdk API usage violations.", "type": "object", "properties": { "targetSdkVersion": { "description": "Specifies the API Level on which the application is designed to run.", "format": "int32", "type": "integer" }, "exampleApis": { "description": "Examples of the detected API usages.", "type": "array", "items": { "$ref": "NonSdkApi" } }, "uniqueApis": { "description": "Total number of unique Non-SDK API's accessed.", "format": "int32", "type": "integer" }, "minSdkVersion": { "description": "Minimum API level required for the application to run.", "format": "int32", "type": "integer" } } }, "FatalException": { "properties": { "stackTrace": { "description": "The stack trace of the fatal exception. Optional.", "$ref": "StackTrace" } }, "id": "FatalException", "description": "Additional details for a fatal exception.", "type": "object" }, "UIElementTooDeep": { "properties": { "screenId": { "description": "The screen id of the element", "type": "string" }, "screenStateId": { "type": "string", "description": "The screen state id of the element" }, "depth": { "description": "The depth of the screen element", "format": "int32", "type": "integer" } }, "type": "object", "id": "UIElementTooDeep", "description": "A warning that the screen hierarchy is deeper than the recommended threshold." }, "StepDimensionValueEntry": { "type": "object", "id": "StepDimensionValueEntry", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "IosAppInfo": { "properties": { "name": { "type": "string", "description": "The name of the app. Required" } }, "id": "IosAppInfo", "description": "iOS app information", "type": "object" }, "MemoryInfo": { "type": "object", "id": "MemoryInfo", "properties": { "memoryTotalInKibibyte": { "type": "string", "description": "Total memory available on the device in KiB", "format": "int64" }, "memoryCapInKibibyte": { "type": "string", "description": "Maximum memory that can be allocated to the process in KiB", "format": "int64" } } }, "ToolExitCode": { "properties": { "number": { "description": "Tool execution exit code. A value of 0 means that the execution was successful. - In response: always set - In create/update request: always set", "format": "int32", "type": "integer" } }, "id": "ToolExitCode", "description": "Exit code from a tool execution.", "type": "object" }, "IosTestLoop": { "id": "IosTestLoop", "description": "A game loop test of an iOS application.", "type": "object", "properties": { "bundleId": { "description": "Bundle ID of the app.", "type": "string" } } }, "Step": { "properties": { "creationTime": { "description": "The time when the step was created. - In response: always set - In create/update request: never set", "$ref": "Timestamp" }, "hasImages": { "type": "boolean", "description": "Whether any of the outputs of this step are images whose thumbnails can be fetched with ListThumbnails. - In response: always set - In create/update request: never set" }, "multiStep": { "description": "Details when multiple steps are run with the same configuration as a group. These details can be used identify which group this step is part of. It also identifies the groups 'primary step' which indexes all the group members. - In response: present if previously set. - In create request: optional, set iff this step was performed more than once. - In update request: optional", "$ref": "MultiStep" }, "toolExecutionStep": { "description": "An execution of a tool (used for steps we don't explicitly support).", "$ref": "ToolExecutionStep" }, "runDuration": { "description": "How long it took for this step to run. If unset, this is set to the difference between creation_time and completion_time when the step is set to the COMPLETE state. In some cases, it is appropriate to set this value separately: For instance, if a step is created, but the operation it represents is queued for a few minutes before it executes, it would be appropriate not to include the time spent queued in its run_duration. PRECONDITION_FAILED will be returned if one attempts to set a run_duration on a step which already has this field set. - In response: present if previously set; always present on COMPLETE step - In create request: optional - In update request: optional", "$ref": "Duration" }, "outcome": { "description": "Classification of the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional", "$ref": "Outcome" }, "stepId": { "type": "string", "description": "A unique identifier within a Execution for this Step. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response: always set - In create/update request: never set" }, "testExecutionStep": { "description": "An execution of a test runner.", "$ref": "TestExecutionStep" }, "description": { "type": "string", "description": "A description of this tool For example: mvn clean package -D skipTests=true - In response: present if set by create/update request - In create/update request: optional" }, "state": { "enumDescriptions": [ "Should never be in this state. Exists for proto deserialization backward compatibility.", "The Execution/Step is created, ready to run, but not running yet. If an Execution/Step is created without initial state, it is assumed that the Execution/Step is in PENDING state.", "The Execution/Step is in progress.", "The finalized, immutable state. Steps/Executions in this state cannot be modified." ], "description": "The initial state is IN_PROGRESS. The only legal state transitions are * IN_PROGRESS -\u003e COMPLETE A PRECONDITION_FAILED will be returned if an invalid transition is requested. It is valid to create Step with a state set to COMPLETE. The state can only be set to COMPLETE once. A PRECONDITION_FAILED will be returned if the state is set to COMPLETE multiple times. - In response: always set - In create/update request: optional", "enum": [ "unknownState", "pending", "inProgress", "complete" ], "type": "string" }, "labels": { "type": "array", "items": { "$ref": "StepLabelsEntry" }, "description": "Arbitrary user-supplied key/value pairs that are associated with the step. Users are responsible for managing the key namespace such that keys don't accidentally collide. An INVALID_ARGUMENT will be returned if the number of labels exceeds 100 or if the length of any of the keys or values exceeds 100 characters. - In response: always set - In create request: optional - In update request: optional; any new key/value pair will be added to the map, and any new value for an existing key will update that key's value" }, "deviceUsageDuration": { "description": "How much the device resource is used to perform the test. This is the device usage used for billing purpose, which is different from the run_duration, for example, infrastructure failure won't be charged for device usage. PRECONDITION_FAILED will be returned if one attempts to set a device_usage on a step which already has this field set. - In response: present if previously set. - In create request: optional - In update request: optional", "$ref": "Duration" }, "dimensionValue": { "type": "array", "items": { "$ref": "StepDimensionValueEntry" }, "description": "If the execution containing this step has any dimension_definition set, then this field allows the child to specify the values of the dimensions. The keys must exactly match the dimension_definition of the execution. For example, if the execution has `dimension_definition = ['attempt', 'device']` then a step must define values for those dimensions, eg. `dimension_value = ['attempt': '1', 'device': 'Nexus 6']` If a step does not participate in one dimension of the matrix, the value for that dimension should be empty string. For example, if one of the tests is executed by a runner which does not support retries, the step could have `dimension_value = ['attempt': '', 'device': 'Nexus 6']` If the step does not participate in any dimensions of the matrix, it may leave dimension_value unset. A PRECONDITION_FAILED will be returned if any of the keys do not exist in the dimension_definition of the execution. A PRECONDITION_FAILED will be returned if another step in this execution already has the same name and dimension_value, but differs on other data fields, for example, step field is different. A PRECONDITION_FAILED will be returned if dimension_value is set, and there is a dimension_definition in the execution which is not specified as one of the keys. - In response: present if set by create - In create request: optional - In update request: never set" }, "completionTime": { "description": "The time when the step status was set to complete. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set", "$ref": "Timestamp" }, "name": { "description": "A short human-readable name to display in the UI. Maximum of 100 characters. For example: Clean build A PRECONDITION_FAILED will be returned upon creating a new step if it shares its name and dimension_value with an existing step. If two steps represent a similar action, but have different dimension values, they should share the same name. For instance, if the same set of tests is run on two different platforms, the two steps should have the same name. - In response: always set - In create request: always set - In update request: never set", "type": "string" } }, "id": "Step", "description": "A Step represents a single operation performed as part of Execution. A step can be used to represent the execution of a tool ( for example a test runner execution or an execution of a compiler). Steps can overlap (for instance two steps might have the same start time if some operations are done in parallel). Here is an example, let's consider that we have a continuous build is executing a test runner for each iteration. The workflow would look like: - user creates a Execution with id 1 - user creates a TestExecutionStep with id 100 for Execution 1 - user update TestExecutionStep with id 100 to add a raw xml log + the service parses the xml logs and returns a TestExecutionStep with updated TestResult(s). - user update the status of TestExecutionStep with id 100 to COMPLETE A Step can be updated until its state is set to COMPLETE at which points it becomes immutable.", "type": "object" }, "ListStepThumbnailsResponse": { "properties": { "nextPageToken": { "description": "A continuation token to resume the query at the next item. If set, indicates that there are more thumbnails to read, by calling list again with this value in the page_token field.", "type": "string" }, "thumbnails": { "type": "array", "items": { "$ref": "Image" }, "description": "A list of image data. Images are returned in a deterministic order; they are ordered by these factors, in order of importance: * First, by their associated test case. Images without a test case are considered greater than images with one. * Second, by their creation time. Images without a creation time are greater than images with one. * Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep)." } }, "id": "ListStepThumbnailsResponse", "description": "A response containing the thumbnails in a step.", "type": "object" }, "AndroidAppInfo": { "properties": { "packageName": { "type": "string", "description": "The package name of the app. Required." }, "versionCode": { "description": "The internal version code of the app. Optional.", "type": "string" }, "name": { "type": "string", "description": "The name of the app. Optional" }, "versionName": { "type": "string", "description": "The version name of the app. Optional." } }, "id": "AndroidAppInfo", "description": "Android app information.", "type": "object" }, "ListStepAccessibilityClustersResponse": { "properties": { "name": { "type": "string", "description": "A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Always presents." }, "clusters": { "description": "A sequence of accessibility suggestions, grouped into clusters. Within the sequence, clusters that belong to the same SuggestionCategory should be adjacent. Within each category, clusters should be ordered by their SuggestionPriority (ERRORs first). The categories should be ordered by their highest priority cluster.", "type": "array", "items": { "$ref": "SuggestionClusterProto" } } }, "type": "object", "id": "ListStepAccessibilityClustersResponse", "description": "Response message for AccessibilityService.ListStepAccessibilityClusters." }, "GraphicsStats": { "type": "object", "id": "GraphicsStats", "description": "Graphics statistics for the App. The information is collected from 'adb shell dumpsys graphicsstats'. For more info see: https://developer.android.com/training/testing/performance.html Statistics will only be present for API 23+.", "properties": { "jankyFrames": { "type": "string", "description": "Total frames with slow render time. Should be \u003c= total_frames.", "format": "int64" }, "p90Millis": { "description": "90th percentile frame render time in milliseconds.", "format": "int64", "type": "string" }, "p50Millis": { "type": "string", "description": "50th percentile frame render time in milliseconds.", "format": "int64" }, "slowBitmapUploadCount": { "type": "string", "description": "Total \"slow bitmap upload\" events.", "format": "int64" }, "highInputLatencyCount": { "type": "string", "description": "Total \"high input latency\" events.", "format": "int64" }, "totalFrames": { "type": "string", "description": "Total frames rendered by package.", "format": "int64" }, "slowUiThreadCount": { "type": "string", "description": "Total \"slow UI thread\" events.", "format": "int64" }, "buckets": { "description": "Histogram of frame render times. There should be 154 buckets ranging from [5ms, 6ms) to [4950ms, infinity)", "type": "array", "items": { "$ref": "GraphicsStatsBucket" } }, "missedVsyncCount": { "description": "Total \"missed vsync\" events.", "format": "int64", "type": "string" }, "p95Millis": { "description": "95th percentile frame render time in milliseconds.", "format": "int64", "type": "string" }, "slowDrawCount": { "description": "Total \"slow draw\" events.", "format": "int64", "type": "string" }, "p99Millis": { "type": "string", "description": "99th percentile frame render time in milliseconds.", "format": "int64" } } }, "ListEnvironmentsResponse": { "id": "ListEnvironmentsResponse", "description": "Response message for EnvironmentService.ListEnvironments.", "type": "object", "properties": { "historyId": { "type": "string", "description": "A History id. Always set." }, "nextPageToken": { "description": "A continuation token to resume the query at the next item. Will only be set if there are more Environments to fetch.", "type": "string" }, "environments": { "type": "array", "items": { "$ref": "Environment" }, "description": "Environments. Always set." }, "projectId": { "type": "string", "description": "A Project id. Always set." }, "executionId": { "type": "string", "description": "A Execution id Always set." } } }, "UsedRoboIgnoreDirective": { "type": "object", "id": "UsedRoboIgnoreDirective", "description": "Additional details of a used Robo directive with an ignore action. Note: This is a different scenario than unused directive.", "properties": { "resourceName": { "type": "string", "description": "The name of the resource that was ignored." } } }, "Environment": { "id": "Environment", "description": "An Environment represents the set of test runs (Steps) from the parent Execution that are configured with the same set of dimensions (Model, Version, Locale, and Orientation). Multiple such runs occur particularly because of features like sharding (splitting up a test suite to run in parallel across devices) and reruns (running a test multiple times to check for different outcomes).", "type": "object", "properties": { "historyId": { "type": "string", "description": "Output only. A History id." }, "creationTime": { "description": "Output only. The time when the Environment was created.", "$ref": "Timestamp" }, "environmentResult": { "description": "Merged result of the environment.", "$ref": "MergedResult" }, "environmentId": { "type": "string", "description": "Output only. An Environment id." }, "projectId": { "description": "Output only. A Project id.", "type": "string" }, "displayName": { "type": "string", "description": "A short human-readable name to display in the UI. Maximum of 100 characters. For example: Nexus 5, API 27." }, "completionTime": { "description": "Output only. The time when the Environment status was set to complete. This value will be set automatically when state transitions to COMPLETE.", "$ref": "Timestamp" }, "shardSummaries": { "type": "array", "items": { "$ref": "ShardSummary" }, "description": "Output only. Summaries of shards. Only one shard will present unless sharding feature is enabled in TestExecutionService." }, "resultsStorage": { "description": "The location where output files are stored in the user bucket.", "$ref": "ResultsStorage" }, "executionId": { "description": "Output only. An Execution id.", "type": "string" }, "dimensionValue": { "description": "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", "type": "array", "items": { "$ref": "EnvironmentDimensionValueEntry" } } } }, "FileReference": { "type": "object", "id": "FileReference", "description": "A reference to a file.", "properties": { "fileUri": { "type": "string", "description": "The URI of a file stored in Google Cloud Storage. For example: `http://storage.googleapis.com/mybucket/path/to/test.xml` or in Cloud Storage URI format: `gs://mybucket/path/to/test.xml` with version-specific info, `gs://mybucket/path/to/test.xml#1360383693690000` An INVALID_ARGUMENT error will be returned if the URI format is not supported. - In response: always set - In create/update request: always set" } } }, "BatchCreatePerfSamplesResponse": { "properties": { "perfSamples": { "type": "array", "items": { "$ref": "PerfSample" } } }, "type": "object", "id": "BatchCreatePerfSamplesResponse" }, "AndroidTestLoop": { "properties": {}, "id": "AndroidTestLoop", "description": "Test Loops are tests that can be launched by the app itself, determining when to run by listening for an intent.", "type": "object" }, "LauncherActivityNotFound": { "properties": {}, "type": "object", "id": "LauncherActivityNotFound", "description": "Failed to find the launcher activity of an app." }, "PerfMetricsSummary": { "id": "PerfMetricsSummary", "description": "A summary of perf metrics collected and performance environment info", "type": "object", "properties": { "projectId": { "description": "The cloud project @OutputOnly", "type": "string" }, "executionId": { "description": "A tool results execution ID. @OutputOnly", "type": "string" }, "perfMetrics": { "description": "Set of resource collected", "type": "array", "items": { "enumDescriptions": [ "", "", "", "", "" ], "type": "string", "enum": [ "perfMetricTypeUnspecified", "memory", "cpu", "network", "graphics" ] } }, "appStartTime": { "$ref": "AppStartTime" }, "graphicsStats": { "description": "Graphics statistics for the entire run. Statistics are reset at the beginning of the run and collected at the end of the run.", "$ref": "GraphicsStats", "deprecated": true }, "stepId": { "description": "A tool results step ID. @OutputOnly", "type": "string" }, "historyId": { "type": "string", "description": "A tool results history ID. @OutputOnly" }, "perfEnvironment": { "description": "Describes the environment in which the performance metrics were collected", "$ref": "PerfEnvironment" } } }, "GraphicsStatsBucket": { "type": "object", "id": "GraphicsStatsBucket", "properties": { "frameCount": { "description": "Number of frames in the bucket.", "format": "int64", "type": "string" }, "renderMillis": { "type": "string", "description": "Lower bound of render time in milliseconds.", "format": "int64" } } }, "ANR": { "id": "ANR", "description": "Additional details for an ANR crash.", "type": "object", "properties": { "stackTrace": { "description": "The stack trace of the ANR crash. Optional.", "$ref": "StackTrace" } } }, "UnspecifiedWarning": { "id": "UnspecifiedWarning", "description": "Default unspecified warning.", "type": "object", "properties": {} }, "IosRoboTest": { "type": "object", "id": "IosRoboTest", "description": "A Robo test for an iOS application.", "properties": {} }, "Thumbnail": { "id": "Thumbnail", "description": "A single thumbnail, with its size and format.", "type": "object", "properties": { "contentType": { "type": "string", "description": "The thumbnail's content type, i.e. \"image/png\". Always set." }, "heightPx": { "description": "The height of the thumbnail, in pixels. Always set.", "format": "int32", "type": "integer" }, "widthPx": { "type": "integer", "description": "The width of the thumbnail, in pixels. Always set.", "format": "int32" }, "data": { "description": "The thumbnail file itself. That is, the bytes here are precisely the bytes that make up the thumbnail file; they can be served as an image as-is (with the appropriate content type.) Always set.", "format": "byte", "type": "string" } } }, "ListPerfSampleSeriesResponse": { "properties": { "perfSampleSeries": { "description": "The resulting PerfSampleSeries sorted by id", "type": "array", "items": { "$ref": "PerfSampleSeries" } } }, "id": "ListPerfSampleSeriesResponse", "type": "object" }, "ToolOutputReference": { "properties": { "output": { "description": "A FileReference to an output file. - In response: always set - In create/update request: always set", "$ref": "FileReference" }, "creationTime": { "description": "The creation time of the file. - In response: present if set by create/update request - In create/update request: optional", "$ref": "Timestamp" }, "testCase": { "description": "The test case to which this output file belongs. - In response: present if set by create/update request - In create/update request: optional", "$ref": "TestCaseReference" } }, "id": "ToolOutputReference", "description": "A reference to a ToolExecution output file.", "type": "object" }, "Specification": { "type": "object", "id": "Specification", "description": "The details about how to run the execution.", "properties": { "androidTest": { "description": "An Android mobile test execution specification.", "$ref": "AndroidTest" }, "iosTest": { "description": "An iOS mobile test execution specification.", "$ref": "IosTest" } } }, "PerformedGoogleLogin": { "properties": {}, "id": "PerformedGoogleLogin", "description": "A notification that Robo signed in with Google.", "type": "object" }, "AndroidInstrumentationTest": { "properties": { "testPackageId": { "type": "string", "description": "The java package for the test to be executed. Required" }, "testRunnerClass": { "type": "string", "description": "The InstrumentationTestRunner class. Required" }, "testTargets": { "type": "array", "items": { "type": "string" }, "description": "Each target must be fully qualified with the package name or class name, in one of these formats: - \"package package_name\" - \"class package_name.class_name\" - \"class package_name.class_name#method_name\" If empty, all targets in the module will be run." }, "useOrchestrator": { "type": "boolean", "description": "The flag indicates whether Android Test Orchestrator will be used to run test or not." } }, "id": "AndroidInstrumentationTest", "description": "A test of an Android application that can control an Android component independently of its normal lifecycle. See for more information on types of Android tests.", "type": "object" }, "Duration": { "type": "object", "id": "Duration", "description": " A Duration represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like \"day\" or \"month\". It is related to Timestamp in that the difference between two Timestamp values is a Duration and it can be added or subtracted from a Timestamp. Range is approximately +-10,000 years.", "properties": { "seconds": { "description": "Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years", "format": "int64", "type": "string" }, "nanos": { "description": "Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 `seconds` field and a positive or negative `nanos` field. For durations of one second or more, a non-zero value for the `nanos` field must be of the same sign as the `seconds` field. Must be from -999,999,999 to +999,999,999 inclusive.", "format": "int32", "type": "integer" } } }, "PerformedMonkeyActions": { "properties": { "totalActions": { "description": "The total number of monkey actions performed during the crawl.", "format": "int32", "type": "integer" } }, "id": "PerformedMonkeyActions", "description": "A notification that Robo performed some monkey actions.", "type": "object" }, "InconclusiveDetail": { "properties": { "infrastructureFailure": { "description": "If the test runner could not determine success or failure because the test depends on a component other than the system under test which failed. For example, a mobile test requires provisioning a device where the test executes, and that provisioning can fail.", "type": "boolean" }, "hasErrorLogs": { "type": "boolean", "description": "If results are being provided to the user in certain cases of infrastructure failures" }, "abortedByUser": { "description": "If the end user aborted the test execution before a pass or fail could be determined. For example, the user pressed ctrl-c which sent a kill signal to the test runner while the test was running.", "type": "boolean" } }, "type": "object", "id": "InconclusiveDetail", "description": "Details for an outcome with an INCONCLUSIVE outcome summary." }, "SuccessDetail": { "properties": { "otherNativeCrash": { "description": "If a native process other than the app crashed.", "type": "boolean" } }, "type": "object", "id": "SuccessDetail", "description": "Details for an outcome with a SUCCESS outcome summary. LINT.IfChange" }, "ListStepsResponse": { "properties": { "steps": { "type": "array", "items": { "$ref": "Step" }, "description": "Steps." }, "nextPageToken": { "type": "string", "description": "A continuation token to resume the query at the next item. If set, indicates that there are more steps to read, by calling list again with this value in the page_token field." } }, "type": "object", "id": "ListStepsResponse", "description": "Response message for StepService.List." }, "UpgradeInsight": { "type": "object", "id": "UpgradeInsight", "description": "This insight is a recommendation to upgrade a given library to the specified version, in order to avoid dependencies on non-SDK APIs.", "properties": { "upgradeToVersion": { "description": "The suggested version to upgrade to. Optional: In case we are not sure which version solves this problem", "type": "string" }, "packageName": { "description": "The name of the package to be upgraded.", "type": "string" } } }, "ListExecutionsResponse": { "id": "ListExecutionsResponse", "type": "object", "properties": { "executions": { "description": "Executions. Always set.", "type": "array", "items": { "$ref": "Execution" } }, "nextPageToken": { "description": "A continuation token to resume the query at the next item. Will only be set if there are more Executions to fetch.", "type": "string" } } }, "History": { "properties": { "displayName": { "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", "type": "string" }, "testPlatform": { "type": "string", "description": "The platform of the test history. - In response: always set. Returns the platform of the last execution if unknown.", "enum": [ "unknownPlatform", "android", "ios" ], "enumDescriptions": [ "", "", "" ] }, "name": { "description": "A name to uniquely identify a history within a project. Maximum of 200 characters. - In response always set - In create request: always set", "type": "string" }, "historyId": { "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", "type": "string" } }, "id": "History", "description": "A History represents a sorted list of Executions ordered by the start_timestamp_millis field (descending). It can be used to group all the Executions of a continuous build. Note that the ordering only operates on one-dimension. If a repository has multiple branches, it means that multiple histories will need to be used in order to order Executions per branch.", "type": "object" }, "ListTestCasesResponse": { "properties": { "testCases": { "type": "array", "items": { "$ref": "TestCase" }, "description": "List of test cases." }, "nextPageToken": { "type": "string" } }, "type": "object", "id": "ListTestCasesResponse", "description": "Response message for StepService.ListTestCases." }, "Any": { "properties": { "value": { "type": "string", "description": "Must be a valid serialized protocol buffer of the above specified type.", "format": "byte" }, "typeUrl": { "description": "A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL's path must represent the fully qualified name of the type (as in `path/google.protobuf.Duration`). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme `http`, `https`, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, `https` is assumed. * An HTTP GET on the URL must yield a google.protobuf.Type value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.", "type": "string" } }, "type": "object", "id": "Any", "description": " `Any` contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type. Example 1: Pack and unpack a message in C++. Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... } Example 2: Pack and unpack a message in Java. Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } Example 3: Pack and unpack a message in Python. foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ... Example 4: Pack and unpack a message in Go foo := &pb.Foo{...} any, err := ptypes.MarshalAny(foo) ... foo := &pb.Foo{} if err := ptypes.UnmarshalAny(any, foo); err != nil { ... } The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example \"foo.bar.com/x/y.z\" will yield type name \"y.z\". # JSON The JSON representation of an `Any` value uses the regular representation of the deserialized, embedded message, with an additional field `@type` which contains the type URL. Example: package google.profile; message Person { string first_name = 1; string last_name = 2; } { \"@type\": \"type.googleapis.com/google.profile.Person\", \"firstName\": , \"lastName\": } If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field `value` which holds the custom JSON in addition to the `@type` field. Example (for message google.protobuf.Duration): { \"@type\": \"type.googleapis.com/google.protobuf.Duration\", \"value\": \"1.212s\" }" }, "SuggestionClusterProto": { "properties": { "category": { "type": "string", "description": "Category in which these types of suggestions should appear. Always set.", "enum": [ "unknownCategory", "contentLabeling", "touchTargetSize", "lowContrast", "implementation" ], "enumDescriptions": [ "", "", "", "", "" ] }, "suggestions": { "description": "A sequence of suggestions. All of the suggestions within a cluster must have the same SuggestionPriority and belong to the same SuggestionCategory. Suggestions with the same screenshot URL should be adjacent.", "type": "array", "items": { "$ref": "SuggestionProto" } } }, "id": "SuggestionClusterProto", "description": "A set of similar suggestions that we suspect are closely related. This proto and most of the nested protos are branched from foxandcrown.prelaunchreport.service.SuggestionClusterProto, replacing PLR's dependencies with FTL's.", "type": "object" }, "ListHistoriesResponse": { "properties": { "nextPageToken": { "type": "string", "description": "A continuation token to resume the query at the next item. Will only be set if there are more histories to fetch. Tokens are valid for up to one hour from the time of the first list request. For instance, if you make a list request at 1PM and use the token from this first request 10 minutes later, the token from this second response will only be valid for 50 minutes." }, "histories": { "description": "Histories.", "type": "array", "items": { "$ref": "History" } } }, "id": "ListHistoriesResponse", "description": "Response message for HistoryService.List", "type": "object" }, "PerfEnvironment": { "type": "object", "id": "PerfEnvironment", "description": "Encapsulates performance environment info", "properties": { "cpuInfo": { "description": "CPU related environment info", "$ref": "CPUInfo" }, "memoryInfo": { "description": "Memory related environment info", "$ref": "MemoryInfo" } } }, "TestSuiteOverview": { "id": "TestSuiteOverview", "description": "A summary of a test suite result either parsed from XML or uploaded directly by a user. Note: the API related comments are for StepService only. This message is also being used in ExecutionService in a read only mode for the corresponding step.", "type": "object", "properties": { "failureCount": { "type": "integer", "description": "Number of failed test cases, typically set by the service by parsing the xml_source. May also be set by the user. - In create/response: always set - In update request: never", "format": "int32" }, "skippedCount": { "description": "Number of test cases not run, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never", "format": "int32", "type": "integer" }, "xmlSource": { "description": "If this test suite was parsed from XML, this is the URI where the original XML file is stored. Note: Multiple test suites can share the same xml_source Returns INVALID_ARGUMENT if the uri format is not supported. - In create/response: optional - In update request: never", "$ref": "FileReference" }, "totalCount": { "type": "integer", "description": "Number of test cases, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never", "format": "int32" }, "errorCount": { "description": "Number of test cases in error, typically set by the service by parsing the xml_source. - In create/response: always set - In update request: never", "format": "int32", "type": "integer" }, "name": { "description": "The name of the test suite. - In create/response: always set - In update request: never", "type": "string" }, "elapsedTime": { "description": "Elapsed time of test suite.", "$ref": "Duration" }, "flakyCount": { "description": "Number of flaky test cases, set by the service by rolling up flaky test attempts. Present only for rollup test suite overview at environment level. A step cannot have flaky test cases.", "format": "int32", "type": "integer" } } }, "StackTrace": { "properties": { "exception": { "description": "The stack trace message. Required", "type": "string" } }, "type": "object", "id": "StackTrace", "description": "A stacktrace." }, "DetectedAppSplashScreen": { "properties": {}, "type": "object", "id": "DetectedAppSplashScreen", "description": "A notification that Robo detected a splash screen provided by app (vs. Android OS splash screen)." }, "Execution": { "properties": { "executionId": { "description": "A unique identifier within a History for this Execution. Returns INVALID_ARGUMENT if this field is set or overwritten by the caller. - In response always set - In create/update request: never set", "type": "string" }, "completionTime": { "description": "The time when the Execution status transitioned to COMPLETE. This value will be set automatically when state transitions to COMPLETE. - In response: set if the execution state is COMPLETE. - In create/update request: never set", "$ref": "Timestamp" }, "creationTime": { "description": "The time when the Execution was created. This value will be set automatically when CreateExecution is called. - In response: always set - In create/update request: never set", "$ref": "Timestamp" }, "specification": { "description": "Lightweight information about execution request. - In response: present if set by create - In create: optional - In update: optional", "$ref": "Specification" }, "state": { "description": "The initial state is IN_PROGRESS. The only legal state transitions is from IN_PROGRESS to COMPLETE. A PRECONDITION_FAILED will be returned if an invalid transition is requested. The state can only be set to COMPLETE once. A FAILED_PRECONDITION will be returned if the state is set to COMPLETE multiple times. If the state is set to COMPLETE, all the in-progress steps within the execution will be set as COMPLETE. If the outcome of the step is not set, the outcome will be set to INCONCLUSIVE. - In response always set - In create/update request: optional", "enum": [ "unknownState", "pending", "inProgress", "complete" ], "type": "string", "enumDescriptions": [ "Should never be in this state. Exists for proto deserialization backward compatibility.", "The Execution/Step is created, ready to run, but not running yet. If an Execution/Step is created without initial state, it is assumed that the Execution/Step is in PENDING state.", "The Execution/Step is in progress.", "The finalized, immutable state. Steps/Executions in this state cannot be modified." ] }, "dimensionDefinitions": { "description": "The dimensions along which different steps in this execution may vary. This must remain fixed over the life of the execution. Returns INVALID_ARGUMENT if this field is set in an update request. Returns INVALID_ARGUMENT if the same name occurs in more than one dimension_definition. Returns INVALID_ARGUMENT if the size of the list is over 100. - In response: present if set by create - In create request: optional - In update request: never set", "type": "array", "items": { "$ref": "MatrixDimensionDefinition" } }, "testExecutionMatrixId": { "type": "string", "description": "TestExecution Matrix ID that the TestExecutionService uses. - In response: present if set by create - In create: optional - In update: never set" }, "outcome": { "description": "Classify the result, for example into SUCCESS or FAILURE - In response: present if set by create/update request - In create/update request: optional", "$ref": "Outcome" } }, "id": "Execution", "description": "An Execution represents a collection of Steps. For instance, it could represent: - a mobile test executed across a range of device configurations - a jenkins job with a build step followed by a test step The maximum size of an execution message is 1 MiB. An Execution can be updated until its state is set to COMPLETE at which point it becomes immutable.", "type": "object" }, "StepSummary": { "properties": {}, "id": "StepSummary", "description": "Lightweight summary of a step within this execution.", "type": "object" }, "StartActivityNotFound": { "type": "object", "id": "StartActivityNotFound", "description": "User provided intent failed to resolve to an activity.", "properties": { "action": { "type": "string" }, "uri": { "type": "string" } } }, "ResultsStorage": { "properties": { "resultsStoragePath": { "description": "The root directory for test results.", "$ref": "FileReference" }, "xunitXmlFile": { "description": "The path to the Xunit XML file.", "$ref": "FileReference" } }, "type": "object", "id": "ResultsStorage", "description": "The storage for test results." }, "PerfSample": { "properties": { "value": { "description": "Value observed", "format": "double", "type": "number" }, "sampleTime": { "description": "Timestamp of collection.", "$ref": "Timestamp" } }, "type": "object", "id": "PerfSample", "description": "Resource representing a single performance measure or data point" }, "EnvironmentDimensionValueEntry": { "id": "EnvironmentDimensionValueEntry", "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } } }, "batchPath": "batch", "fullyEncodeReservedExpansion": true, "baseUrl": "https://toolresults.googleapis.com/", "parameters": { "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { "location": "query", "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "enum": [ "1", "2" ] }, "key": { "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", "type": "string", "location": "query" }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], "location": "query", "default": "json" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "type": "string", "location": "query" }, "access_token": { "description": "OAuth access token.", "type": "string", "location": "query" }, "prettyPrint": { "type": "boolean", "location": "query", "description": "Returns response with indentations and line breaks.", "default": "true" }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" } }, "resources": { "projects": { "resources": { "histories": { "methods": { "create": { "response": { "$ref": "History" }, "id": "toolresults.projects.histories.create", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories", "parameterOrder": [ "projectId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories", "description": "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", "httpMethod": "POST", "request": { "$ref": "History" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "requestId": { "description": "A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.", "location": "query", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true } } }, "get": { "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}", "response": { "$ref": "History" }, "id": "toolresults.projects.histories.get", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true } }, "parameterOrder": [ "projectId", "historyId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}", "description": "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", "httpMethod": "GET" }, "list": { "parameters": { "pageToken": { "description": "A continuation token to resume the query at the next item. Optional.", "location": "query", "type": "string" }, "filterByName": { "description": "If set, only return histories with the given name. Optional.", "location": "query", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "pageSize": { "description": "The maximum number of Histories to fetch. Default value: 20. The server will use this default if the field is not set or has a value of 0. Any value greater than 100 will be treated as 100. Optional.", "format": "int32", "location": "query", "type": "integer" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "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", "path": "toolresults/v1beta3/projects/{projectId}/histories", "parameterOrder": [ "projectId" ], "flatPath": "toolresults/v1beta3/projects/{projectId}/histories", "id": "toolresults.projects.histories.list", "response": { "$ref": "ListHistoriesResponse" } } }, "resources": { "executions": { "resources": { "environments": { "methods": { "get": { "httpMethod": "GET", "description": "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", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}", "parameterOrder": [ "projectId", "historyId", "executionId", "environmentId" ], "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. A Project id.", "required": true }, "executionId": { "location": "path", "type": "string", "description": "Required. An Execution id.", "required": true }, "historyId": { "description": "Required. A History id.", "required": true, "location": "path", "type": "string" }, "environmentId": { "location": "path", "type": "string", "description": "Required. An Environment id.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.histories.executions.environments.get", "response": { "$ref": "Environment" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments/{environmentId}" }, "list": { "httpMethod": "GET", "description": "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", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments", "parameterOrder": [ "projectId", "historyId", "executionId" ], "parameters": { "projectId": { "location": "path", "type": "string", "description": "Required. A Project id.", "required": true }, "executionId": { "description": "Required. An Execution id.", "required": true, "location": "path", "type": "string" }, "pageSize": { "description": "The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0.", "format": "int32", "location": "query", "type": "integer" }, "historyId": { "description": "Required. A History id.", "required": true, "location": "path", "type": "string" }, "pageToken": { "description": "A continuation token to resume the query at the next item.", "location": "query", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.histories.executions.environments.list", "response": { "$ref": "ListEnvironmentsResponse" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/environments" } } }, "clusters": { "methods": { "get": { "description": "Retrieves a single screenshot cluster by its ID", "httpMethod": "GET", "parameterOrder": [ "projectId", "historyId", "executionId", "clusterId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}", "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "location": "path", "type": "string", "description": "An Execution id. Required.", "required": true }, "clusterId": { "description": "A Cluster id Required.", "required": true, "location": "path", "type": "string" }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.histories.executions.clusters.get", "response": { "$ref": "ScreenshotCluster" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters/{clusterId}" }, "list": { "description": "Lists Screenshot Clusters Returns the list of screenshot clusters corresponding to an execution. Screenshot clusters are created after the execution is finished. Clusters are created from a set of screenshots. Between any two screenshots, a matching score is calculated based off their metadata that determines how similar they are. Screenshots are placed in the cluster that has screens which have the highest matching scores.", "httpMethod": "GET", "parameterOrder": [ "projectId", "historyId", "executionId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters", "parameters": { "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "An Execution id. Required.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.histories.executions.clusters.list", "response": { "$ref": "ListScreenshotClustersResponse" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/clusters" } } }, "steps": { "resources": { "thumbnails": { "methods": { "list": { "response": { "$ref": "ListStepThumbnailsResponse" }, "id": "toolresults.projects.histories.executions.steps.thumbnails.list", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/thumbnails", "description": "Lists thumbnails of images attached to a step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from the project, or from any of the images - INVALID_ARGUMENT - if the request is malformed - NOT_FOUND - if the step does not exist, or if any of the images do not exist", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "An Execution id. Required.", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of thumbnails to fetch. Default value: 50. The server will use this default if the field is not set or has a value of 0. Optional.", "format": "int32" }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "pageToken": { "description": "A continuation token to resume the query at the next item. Optional.", "location": "query", "type": "string" }, "stepId": { "location": "path", "type": "string", "description": "A Step id. Required.", "required": true } } } } }, "perfMetricsSummary": { "methods": { "create": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "description": "The cloud project", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "A tool results execution ID.", "required": true }, "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A tool results history ID.", "required": true } }, "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary", "description": "Creates a PerfMetricsSummary resource. Returns the existing one if it has already been created. May return any of the following error code(s): - NOT_FOUND - The containing Step does not exist", "httpMethod": "POST", "request": { "$ref": "PerfMetricsSummary" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary", "response": { "$ref": "PerfMetricsSummary" }, "id": "toolresults.projects.histories.executions.steps.perfMetricsSummary.create" } } }, "testCases": { "methods": { "get": { "response": { "$ref": "TestCase" }, "id": "toolresults.projects.histories.executions.steps.testCases.get", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId", "testCaseId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases/{testCaseId}", "description": "Gets details of a Test Case for a Step. Experimental test cases API. Still in active development. 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 Test Case does not exist", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "testCaseId": { "location": "path", "type": "string", "description": "A Test Case id. Required.", "required": true }, "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "location": "path", "type": "string", "description": "A Execution id Required.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "stepId": { "description": "A Step id. Note: This step must include a TestExecutionStep. Required.", "required": true, "location": "path", "type": "string" } } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "pageToken": { "description": "A continuation token to resume the query at the next item. Optional.", "location": "query", "type": "string" }, "stepId": { "description": "A Step id. Note: This step must include a TestExecutionStep. Required.", "required": true, "location": "path", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "description": "A Execution id Required.", "required": true, "location": "path", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of TestCases to fetch. Default value: 100. The server will use this default if the field is not set or has a value of 0. Optional.", "format": "int32" } }, "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases", "description": "Lists Test Cases attached to a Step. Experimental test cases API. Still in active development. 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 Step does not exist", "httpMethod": "GET", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/testCases", "response": { "$ref": "ListTestCasesResponse" }, "id": "toolresults.projects.histories.executions.steps.testCases.list" } } }, "perfSampleSeries": { "methods": { "create": { "parameters": { "historyId": { "location": "path", "type": "string", "description": "A tool results history ID.", "required": true }, "projectId": { "location": "path", "type": "string", "description": "The cloud project", "required": true }, "executionId": { "description": "A tool results execution ID.", "required": true, "location": "path", "type": "string" }, "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "PerfSampleSeries" }, "description": "Creates a PerfSampleSeries. May return any of the following error code(s): - ALREADY_EXISTS - PerfMetricSummary already exists for the given Step - NOT_FOUND - The containing Step does not exist", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries", "id": "toolresults.projects.histories.executions.steps.perfSampleSeries.create", "response": { "$ref": "PerfSampleSeries" } }, "get": { "parameters": { "projectId": { "description": "The cloud project", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "A tool results execution ID.", "required": true }, "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true }, "sampleSeriesId": { "description": "A sample series id", "required": true, "location": "path", "type": "string" }, "historyId": { "description": "A tool results history ID.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "GET", "description": "Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId", "sampleSeriesId" ], "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}", "id": "toolresults.projects.histories.executions.steps.perfSampleSeries.get", "response": { "$ref": "PerfSampleSeries" } }, "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "description": "The cloud project", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "A tool results execution ID.", "required": true }, "filter": { "location": "query", "enumDescriptions": [ "", "", "", "", "" ], "type": "string", "description": "Specify one or more PerfMetricType values such as CPU to filter the result", "repeated": true, "enum": [ "perfMetricTypeUnspecified", "memory", "cpu", "network", "graphics" ] }, "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A tool results history ID.", "required": true } }, "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries", "description": "Lists PerfSampleSeries for a given Step. The request provides an optional filter which specifies one or more PerfMetricsType to include in the result; if none returns all. The resulting PerfSampleSeries are sorted by ids. May return any of the following canonical error codes: - NOT_FOUND - The containing Step does not exist", "httpMethod": "GET", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries", "response": { "$ref": "ListPerfSampleSeriesResponse" }, "id": "toolresults.projects.histories.executions.steps.perfSampleSeries.list" } }, "resources": { "samples": { "methods": { "list": { "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples", "response": { "$ref": "ListPerfSamplesResponse" }, "id": "toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true }, "sampleSeriesId": { "location": "path", "type": "string", "description": "A sample series id", "required": true }, "historyId": { "description": "A tool results history ID.", "required": true, "location": "path", "type": "string" }, "pageToken": { "description": "Optional, the next_page_token returned in the previous response", "location": "query", "type": "string" }, "projectId": { "description": "The cloud project", "required": true, "location": "path", "type": "string" }, "executionId": { "location": "path", "type": "string", "description": "A tool results execution ID.", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "The default page size is 500 samples, and the maximum size is 5000. If the page_size is greater than 5000, the effective page size will be 5000", "format": "int32" } }, "parameterOrder": [ "projectId", "historyId", "executionId", "stepId", "sampleSeriesId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples", "description": "Lists the Performance Samples of a given Sample Series - The list results are sorted by timestamps ascending - The default page size is 500 samples; and maximum size allowed 5000 - The response token indicates the last returned PerfSample timestamp - When the results size exceeds the page size, submit a subsequent request including the page token to return the rest of the samples up to the page limit May return any of the following canonical error codes: - OUT_OF_RANGE - The specified request page_token is out of valid range - NOT_FOUND - The containing PerfSampleSeries does not exist", "httpMethod": "GET" }, "batchCreate": { "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate", "id": "toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate", "response": { "$ref": "BatchCreatePerfSamplesResponse" }, "parameters": { "stepId": { "location": "path", "type": "string", "description": "A tool results step ID.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A tool results history ID.", "required": true }, "sampleSeriesId": { "description": "A sample series id", "required": true, "location": "path", "type": "string" }, "projectId": { "location": "path", "type": "string", "description": "The cloud project", "required": true }, "executionId": { "description": "A tool results execution ID.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "httpMethod": "POST", "request": { "$ref": "BatchCreatePerfSamplesRequest" }, "description": "Creates a batch of PerfSamples - a client can submit multiple batches of Perf Samples through repeated calls to this method in order to split up a large request payload - duplicates and existing timestamp entries will be ignored. - the batch operation may partially succeed - the set of elements successfully inserted is returned in the response (omits items which already existed in the database). May return any of the following canonical error codes: - NOT_FOUND - The containing PerfSampleSeries does not exist", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfSampleSeries/{sampleSeriesId}/samples:batchCreate", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId", "sampleSeriesId" ] } } } } } }, "methods": { "create": { "id": "toolresults.projects.histories.executions.steps.create", "response": { "$ref": "Step" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps", "description": "Creates a Step. The returned Step 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 - FAILED_PRECONDITION - if the step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist", "httpMethod": "POST", "request": { "$ref": "Step" }, "parameterOrder": [ "projectId", "historyId", "executionId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps", "parameters": { "historyId": { "description": "Required. A History id.", "required": true, "location": "path", "type": "string" }, "projectId": { "description": "Required. A Project id.", "required": true, "location": "path", "type": "string" }, "executionId": { "description": "Required. An Execution id.", "required": true, "location": "path", "type": "string" }, "requestId": { "location": "query", "type": "string", "description": "A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "httpMethod": "GET", "description": "Gets a Step. 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 Step does not exist", "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "location": "path", "type": "string", "description": "A Execution id. Required.", "required": true }, "stepId": { "location": "path", "type": "string", "description": "A Step id. Required.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.histories.executions.steps.get", "response": { "$ref": "Step" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}" }, "patch": { "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}", "description": "Updates an existing Step with the supplied partial entity. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal (e.g try to upload a duplicate xml file), if the updated step is too large (more than 10Mib) - NOT_FOUND - if the containing Execution does not exist", "httpMethod": "PATCH", "request": { "$ref": "Step" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "stepId": { "location": "path", "type": "string", "description": "A Step id. Required.", "required": true }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" }, "executionId": { "description": "A Execution id. Required.", "required": true, "location": "path", "type": "string" }, "requestId": { "description": "A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.", "location": "query", "type": "string" } }, "response": { "$ref": "Step" }, "id": "toolresults.projects.histories.executions.steps.patch", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}" }, "getPerfMetricsSummary": { "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary", "description": "Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "stepId": { "description": "A tool results step ID.", "required": true, "location": "path", "type": "string" }, "projectId": { "description": "The cloud project", "required": true, "location": "path", "type": "string" }, "executionId": { "description": "A tool results execution ID.", "required": true, "location": "path", "type": "string" }, "historyId": { "description": "A tool results history ID.", "required": true, "location": "path", "type": "string" } }, "response": { "$ref": "PerfMetricsSummary" }, "id": "toolresults.projects.histories.executions.steps.getPerfMetricsSummary", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}/perfMetricsSummary" }, "accessibilityClusters": { "flatPath": "toolresults/v1beta3/projects/{projectsId}/histories/{historiesId}/executions/{executionsId}/steps/{stepsId}:accessibilityClusters", "response": { "$ref": "ListStepAccessibilityClustersResponse" }, "id": "toolresults.projects.histories.executions.steps.accessibilityClusters", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "description": "A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/histories/[^/]+/executions/[^/]+/steps/[^/]+$" }, "locale": { "description": "The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required.", "location": "query", "type": "string" } }, "parameterOrder": [ "name" ], "path": "toolresults/v1beta3/{+name}:accessibilityClusters", "description": "Lists accessibility clusters for a given Step 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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if the locale format is incorrect - NOT_FOUND - if the containing Step does not exist", "httpMethod": "GET" }, "list": { "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps", "parameterOrder": [ "projectId", "historyId", "executionId" ], "httpMethod": "GET", "description": "Lists Steps for a given Execution. The steps are sorted by creation_time in descending order. The step_id key will be used to order the steps with the same creation_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 - FAILED_PRECONDITION - if an argument in the request happens to be invalid; e.g. if an attempt is made to list the children of a nonexistent Step - NOT_FOUND - if the containing Execution does not exist", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "description": "A Execution id. Required.", "required": true, "location": "path", "type": "string" }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of Steps to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional.", "format": "int32" }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "pageToken": { "description": "A continuation token to resume the query at the next item. Optional.", "location": "query", "type": "string" } }, "response": { "$ref": "ListStepsResponse" }, "id": "toolresults.projects.histories.executions.steps.list", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps" }, "publishXunitXmlFiles": { "response": { "$ref": "Step" }, "id": "toolresults.projects.histories.executions.steps.publishXunitXmlFiles", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles", "parameterOrder": [ "projectId", "historyId", "executionId", "stepId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}/steps/{stepId}:publishXunitXmlFiles", "description": "Publish xml files to an existing Step. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to write project - INVALID_ARGUMENT - if the request is malformed - FAILED_PRECONDITION - if the requested state transition is illegal, e.g. try to upload a duplicate xml file or a file too large. - NOT_FOUND - if the containing Execution does not exist", "httpMethod": "POST", "request": { "$ref": "PublishXunitXmlFilesRequest" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" }, "executionId": { "description": "A Execution id. Required.", "required": true, "location": "path", "type": "string" }, "stepId": { "location": "path", "type": "string", "description": "A Step id. Note: This step must include a TestExecutionStep. Required.", "required": true } } } } } }, "methods": { "create": { "id": "toolresults.projects.histories.executions.create", "response": { "$ref": "Execution" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions", "description": "Creates an Execution. The returned Execution 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 History does not exist", "httpMethod": "POST", "request": { "$ref": "Execution" }, "parameterOrder": [ "projectId", "historyId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions", "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "requestId": { "location": "query", "type": "string", "description": "A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended." }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "parameters": { "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "pageSize": { "location": "query", "type": "integer", "description": "The maximum number of Executions to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0. Optional.", "format": "int32" }, "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "pageToken": { "location": "query", "type": "string", "description": "A continuation token to resume the query at the next item. Optional." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists Executions for a given History. The executions are sorted by creation_time in descending order. The execution_id key will be used to order the executions with the same creation_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 containing History does not exist", "httpMethod": "GET", "parameterOrder": [ "projectId", "historyId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions", "id": "toolresults.projects.histories.executions.list", "response": { "$ref": "ListExecutionsResponse" } }, "get": { "response": { "$ref": "Execution" }, "id": "toolresults.projects.histories.executions.get", "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}", "parameterOrder": [ "projectId", "historyId", "executionId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}", "description": "Gets an Execution. 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 Execution does not exist", "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "historyId": { "location": "path", "type": "string", "description": "A History id. Required.", "required": true }, "projectId": { "location": "path", "type": "string", "description": "A Project id. Required.", "required": true }, "executionId": { "description": "An Execution id. Required.", "required": true, "location": "path", "type": "string" } } }, "patch": { "flatPath": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}", "id": "toolresults.projects.histories.executions.patch", "response": { "$ref": "Execution" }, "parameters": { "historyId": { "description": "Required.", "required": true, "location": "path", "type": "string" }, "requestId": { "description": "A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.", "location": "query", "type": "string" }, "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" }, "executionId": { "description": "Required.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Updates an existing Execution with the supplied partial entity. 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 - FAILED_PRECONDITION - if the requested state transition is illegal - NOT_FOUND - if the containing History does not exist", "httpMethod": "PATCH", "request": { "$ref": "Execution" }, "parameterOrder": [ "projectId", "historyId", "executionId" ], "path": "toolresults/v1beta3/projects/{projectId}/histories/{historyId}/executions/{executionId}" } } } } } }, "methods": { "initializeSettings": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" } }, "parameterOrder": [ "projectId" ], "path": "toolresults/v1beta3/projects/{projectId}:initializeSettings", "description": "Creates resources for settings which have not yet been set. Currently, this creates a single resource: a Google Cloud Storage bucket, to be used as the default bucket for this project. The bucket is created in an FTL-own storage project. Except for in rare cases, calling this method in parallel from multiple clients will only create a single bucket. In order to avoid unnecessary storage charges, the bucket is configured to automatically delete objects older than 60 days. The bucket is created with the following permissions: - Owner access for owners of central storage project (FTL-owned) - Writer access for owners/editors of customer project - Reader access for viewers of customer project The default ACL on objects created in the bucket is: - Owner access for owners of central storage project - Reader access for owners/editors/viewers of customer project See Google Cloud Storage documentation for more details. If there is already a default bucket set and the project can access the bucket, this call does nothing. However, if the project doesn't have the permission to access the bucket or the bucket is deleted, a new bucket will be created. May return any canonical error codes, including the following: - PERMISSION_DENIED - if the user is not authorized to write to project - Any error code raised by Google Cloud Storage", "httpMethod": "POST", "flatPath": "toolresults/v1beta3/projects/{projectId}:initializeSettings", "response": { "$ref": "ProjectSettings" }, "id": "toolresults.projects.initializeSettings" }, "getSettings": { "description": "Gets the Tool Results settings for a project. May return any of the following canonical error codes: - PERMISSION_DENIED - if the user is not authorized to read from project", "httpMethod": "GET", "parameterOrder": [ "projectId" ], "path": "toolresults/v1beta3/projects/{projectId}/settings", "parameters": { "projectId": { "description": "A Project id. Required.", "required": true, "location": "path", "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "id": "toolresults.projects.getSettings", "response": { "$ref": "ProjectSettings" }, "flatPath": "toolresults/v1beta3/projects/{projectId}/settings" } } } }, "name": "toolresults", "title": "Cloud Tool Results API", "ownerName": "Google", "rootUrl": "https://toolresults.googleapis.com/", "canonicalName": "Tool Results", "basePath": "", "revision": "20260416", "discoveryVersion": "v1", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" } }