vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
fix-electron-dependency-to-6
DefinitelyTyped/types/gapi.client.toolresults/index.d.ts
Nathan Shively-Sanders 608c146d89 Mark non-npm packages
2019-02-13 15:44:35 -08:00

2003 lines
93 KiB
TypeScript
Raw Permalink Blame History

// Type definitions for non-npm package Google Cloud Tool Results API v1beta3 1.0
// Project: https://firebase.google.com/docs/test-lab/
// Definitions by: Bolisov Alexey <https://github.com/Bolisov>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
// IMPORTANT
// This file was generated by https://github.com/Bolisov/google-api-typings-generator. Please do not edit it manually.
// In case of any problems please post issue to https://github.com/Bolisov/google-api-typings-generator
// Generated from: https://www.googleapis.com/discovery/v1/apis/toolresults/v1beta3/rest
/// <reference types="gapi.client" />
declare namespace gapi.client {
/** Load Cloud Tool Results API v1beta3 */
function load(name: "toolresults", version: "v1beta3"): PromiseLike<void>;
function load(name: "toolresults", version: "v1beta3", callback: () => any): void;
const projects: toolresults.ProjectsResource;
namespace toolresults {
interface AndroidAppInfo {
/** The name of the app. Optional */
name?: string;
/** The package name of the app. Required. */
packageName?: string;
/** The internal version code of the app. Optional. */
versionCode?: string;
/** The version name of the app. Optional. */
versionName?: string;
}
interface AndroidInstrumentationTest {
/** The java package for the test to be executed. Required */
testPackageId?: string;
/** The InstrumentationTestRunner class. Required */
testRunnerClass?: string;
/**
* 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.
*/
testTargets?: string[];
/**
* The flag indicates whether Android Test Orchestrator will be used to run test or not. Test orchestrator is used if either: - orchestrator_option field
* is USE_ORCHESTRATOR, and test runner is compatible with orchestrator. Or - orchestrator_option field is unspecified or ORCHESTRATOR_OPTION_UNSPECIFIED,
* and test runner is compatible with orchestrator.
*/
useOrchestrator?: boolean;
}
interface AndroidRoboTest {
/** The initial activity that should be used to start the app. Optional */
appInitialActivity?: string;
/** The java package for the bootstrap. Optional */
bootstrapPackageId?: string;
/** The runner class for the bootstrap. Optional */
bootstrapRunnerClass?: string;
/** The max depth of the traversal stack Robo can explore. Optional */
maxDepth?: number;
/** The max number of steps/actions Robo can execute. Default is no limit (0). Optional */
maxSteps?: number;
}
interface AndroidTest {
/** Infomation about the application under test. */
androidAppInfo?: AndroidAppInfo;
/** An Android instrumentation test. */
androidInstrumentationTest?: AndroidInstrumentationTest;
/** An Android robo test. */
androidRoboTest?: AndroidRoboTest;
/** Max time a test is allowed to run before it is automatically cancelled. */
testTimeout?: Duration;
}
interface Any {
/**
* A URL/resource name whose content describes the type of the serialized protocol buffer message.
*
* For URLs which use the scheme `http`, `https`, or no scheme, the following restrictions and interpretations apply:
*
* &#42; If no scheme is provided, `https` is assumed. &#42; 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). &#42; An HTTP GET on the URL must yield a
* [google.protobuf.Type][] value in binary format, or produce an error. &#42; 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.)
*
* Schemes other than `http`, `https` (or the empty scheme) might be used with implementation specific semantics.
*/
typeUrl?: string;
/** Must be a valid serialized protocol buffer of the above specified type. */
value?: string;
}
interface AppStartTime {
/**
* 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
*/
fullyDrawnTime?: Duration;
/**
* 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
*/
initialDisplayTime?: Duration;
}
interface BasicPerfSampleSeries {
perfMetricType?: string;
perfUnit?: string;
sampleSeriesLabel?: string;
}
interface BatchCreatePerfSamplesRequest {
/** The set of PerfSamples to create should not include existing timestamps */
perfSamples?: PerfSample[];
}
interface BatchCreatePerfSamplesResponse {
perfSamples?: PerfSample[];
}
interface CPUInfo {
/** description of the device processor ie '1.8 GHz hexa core 64-bit ARMv8-A' */
cpuProcessor?: string;
/** the CPU clock speed in GHz */
cpuSpeedInGhz?: number;
/** the number of CPU cores */
numberOfCores?: number;
}
interface Duration {
/**
* 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.
*/
nanos?: number;
/**
* 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 &#42; 60
* min/hr &#42; 24 hr/day &#42; 365.25 days/year &#42; 10000 years
*/
seconds?: string;
}
interface Execution {
/**
* 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
*/
completionTime?: Timestamp;
/**
* 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
*/
creationTime?: Timestamp;
/**
* 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
*/
executionId?: string;
/**
* Classify the result, for example into SUCCESS or FAILURE
*
* - In response: present if set by create/update request - In create/update request: optional
*/
outcome?: Outcome;
/**
* Lightweight information about execution request.
*
* - In response: present if set by create - In create: optional - In update: optional
*/
specification?: Specification;
/**
* 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
*/
state?: string;
/**
* TestExecution Matrix ID that the TestExecutionService uses.
*
* - In response: present if set by create - In create: optional - In update: never set
*/
testExecutionMatrixId?: string;
}
interface FailureDetail {
/** If the failure was severe because the system (app) under test crashed. */
crashed?: boolean;
/** 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. */
notInstalled?: boolean;
/** If a native process (including any other than the app) crashed. */
otherNativeCrash?: boolean;
/** If the test overran some time limit, and that is why it failed. */
timedOut?: boolean;
/** If the robo was unable to crawl the app; perhaps because the app did not start. */
unableToCrawl?: boolean;
}
interface FileReference {
/**
* The URI of a file stored in Google Cloud Storage.
*
* For example: http://storage.googleapis.com/mybucket/path/to/test.xml or in gsutil 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
*/
fileUri?: string;
}
interface GraphicsStats {
/** Histogram of frame render times. There should be 154 buckets ranging from [5ms, 6ms) to [4950ms, infinity) */
buckets?: GraphicsStatsBucket[];
/** Total "high input latency" events. */
highInputLatencyCount?: string;
/** Total frames with slow render time. Should be <= total_frames. */
jankyFrames?: string;
/** Total "missed vsync" events. */
missedVsyncCount?: string;
/** 50th percentile frame render time in milliseconds. */
p50Millis?: string;
/** 90th percentile frame render time in milliseconds. */
p90Millis?: string;
/** 95th percentile frame render time in milliseconds. */
p95Millis?: string;
/** 99th percentile frame render time in milliseconds. */
p99Millis?: string;
/** Total "slow bitmap upload" events. */
slowBitmapUploadCount?: string;
/** Total "slow draw" events. */
slowDrawCount?: string;
/** Total "slow UI thread" events. */
slowUiThreadCount?: string;
/** Total frames rendered by package. */
totalFrames?: string;
}
interface GraphicsStatsBucket {
/** Number of frames in the bucket. */
frameCount?: string;
/** Lower bound of render time in milliseconds. */
renderMillis?: string;
}
interface History {
/**
* 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
*/
displayName?: string;
/**
* A unique identifier within a project for this History.
*
* Returns INVALID_ARGUMENT if this field is set or overwritten by the caller.
*
* - In response always set - In create request: never set
*/
historyId?: string;
/**
* A name to uniquely identify a history within a project. Maximum of 100 characters.
*
* - In response always set - In create request: always set
*/
name?: string;
}
interface Image {
/** An error explaining why the thumbnail could not be rendered. */
error?: Status;
/**
* 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.
*/
sourceImage?: ToolOutputReference;
/**
* The step to which the image is attached.
*
* Always set.
*/
stepId?: string;
/** The thumbnail. */
thumbnail?: Thumbnail;
}
interface InconclusiveDetail {
/**
* 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.
*/
abortedByUser?: boolean;
/**
* 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.
*/
infrastructureFailure?: boolean;
}
interface ListExecutionsResponse {
/**
* Executions.
*
* Always set.
*/
executions?: Execution[];
/**
* A continuation token to resume the query at the next item.
*
* Will only be set if there are more Executions to fetch.
*/
nextPageToken?: string;
}
interface ListHistoriesResponse {
/** Histories. */
histories?: History[];
/**
* 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.
*/
nextPageToken?: string;
}
interface ListPerfSampleSeriesResponse {
/** The resulting PerfSampleSeries sorted by id */
perfSampleSeries?: PerfSampleSeries[];
}
interface ListPerfSamplesResponse {
/**
* 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
*/
nextPageToken?: string;
perfSamples?: PerfSample[];
}
interface ListScreenshotClustersResponse {
/** The set of clustres associated with an execution Always set */
clusters?: ScreenshotCluster[];
}
interface ListStepThumbnailsResponse {
/**
* 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.
*/
nextPageToken?: string;
/**
* A list of image data.
*
* Images are returned in a deterministic order; they are ordered by these factors, in order of importance: &#42; First, by their associated test case. Images
* without a test case are considered greater than images with one. &#42; Second, by their creation time. Images without a creation time are greater than
* images with one. &#42; Third, by the order in which they were added to the step (by calls to CreateStep or UpdateStep).
*/
thumbnails?: Image[];
}
interface ListStepsResponse {
/**
* 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.
*/
nextPageToken?: string;
/** Steps. */
steps?: Step[];
}
interface MemoryInfo {
/** Maximum memory that can be allocated to the process in KiB */
memoryCapInKibibyte?: string;
/** Total memory available on the device in KiB */
memoryTotalInKibibyte?: string;
}
interface Outcome {
/**
* More information about a FAILURE outcome.
*
* Returns INVALID_ARGUMENT if this field is set but the summary is not FAILURE.
*
* Optional
*/
failureDetail?: FailureDetail;
/**
* More information about an INCONCLUSIVE outcome.
*
* Returns INVALID_ARGUMENT if this field is set but the summary is not INCONCLUSIVE.
*
* Optional
*/
inconclusiveDetail?: InconclusiveDetail;
/**
* More information about a SKIPPED outcome.
*
* Returns INVALID_ARGUMENT if this field is set but the summary is not SKIPPED.
*
* Optional
*/
skippedDetail?: SkippedDetail;
/**
* More information about a SUCCESS outcome.
*
* Returns INVALID_ARGUMENT if this field is set but the summary is not SUCCESS.
*
* Optional
*/
successDetail?: SuccessDetail;
/**
* The simplest way to interpret a result.
*
* Required
*/
summary?: string;
}
interface PerfEnvironment {
/** CPU related environment info */
cpuInfo?: CPUInfo;
/** Memory related environment info */
memoryInfo?: MemoryInfo;
}
interface PerfMetricsSummary {
appStartTime?: AppStartTime;
/** A tool results execution ID. */
executionId?: string;
/** Graphics statistics for the entire run. Statistics are reset at the beginning of the run and collected at the end of the run. */
graphicsStats?: GraphicsStats;
/** A tool results history ID. */
historyId?: string;
/** Describes the environment in which the performance metrics were collected */
perfEnvironment?: PerfEnvironment;
/** Set of resource collected */
perfMetrics?: string[];
/** The cloud project */
projectId?: string;
/** A tool results step ID. */
stepId?: string;
}
interface PerfSample {
/** Timestamp of collection */
sampleTime?: Timestamp;
/** Value observed */
value?: number;
}
interface PerfSampleSeries {
/** Basic series represented by a line chart */
basicPerfSampleSeries?: BasicPerfSampleSeries;
/** A tool results execution ID. */
executionId?: string;
/** A tool results history ID. */
historyId?: string;
/** The cloud project */
projectId?: string;
/** A sample series id */
sampleSeriesId?: string;
/** A tool results step ID. */
stepId?: string;
}
interface ProjectSettings {
/**
* 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
*/
defaultBucket?: string;
/**
* The name of the project's settings.
*
* Always of the form: projects/{project-id}/settings
*
* In update request: never set In response: always set
*/
name?: string;
}
interface PublishXunitXmlFilesRequest {
/**
* URI of the Xunit XML files to publish.
*
* The maximum size of the file this reference is pointing to is 50MB.
*
* Required.
*/
xunitXmlFiles?: FileReference[];
}
interface Screen {
/** File reference of the png file. Required. */
fileReference?: string;
/** Locale of the device that the screenshot was taken on. Required. */
locale?: string;
/** Model of the device that the screenshot was taken on. Required. */
model?: string;
/** OS version of the device that the screenshot was taken on. Required. */
version?: string;
}
interface ScreenshotCluster {
/** A string that describes the activity of every screen in the cluster. */
activity?: string;
/** A unique identifier for the cluster. */
clusterId?: string;
/**
* 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
*/
keyScreen?: Screen;
/** Full list of screens. */
screens?: Screen[];
}
interface SkippedDetail {
/** If the App doesn't support the specific API level. */
incompatibleAppVersion?: boolean;
/** If the App doesn't run on the specific architecture, for example, x86. */
incompatibleArchitecture?: boolean;
/** If the requested OS version doesn't run on the specific device model. */
incompatibleDevice?: boolean;
}
interface Specification {
/** An Android mobile test execution specification. */
androidTest?: AndroidTest;
}
interface StackTrace {
/** Exception cluster ID */
clusterId?: string;
/**
* The stack trace message.
*
* Required
*/
exception?: string;
/** Exception report ID */
reportId?: string;
}
interface Status {
/** The status code, which should be an enum value of [google.rpc.Code][]. */
code?: number;
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
details?: Any[];
/**
* 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.
*/
message?: string;
}
interface Step {
/**
* 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
*/
completionTime?: Timestamp;
/**
* The time when the step was created.
*
* - In response: always set - In create/update request: never set
*/
creationTime?: Timestamp;
/**
* 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
*/
description?: string;
/**
* 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
*/
deviceUsageDuration?: Duration;
/**
* 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
*/
dimensionValue?: StepDimensionValueEntry[];
/**
* 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
*/
hasImages?: boolean;
/**
* 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
*/
labels?: StepLabelsEntry[];
/**
* 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
*/
name?: string;
/**
* Classification of the result, for example into SUCCESS or FAILURE
*
* - In response: present if set by create/update request - In create/update request: optional
*/
outcome?: Outcome;
/**
* 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
*/
runDuration?: Duration;
/**
* The initial state is IN_PROGRESS. The only legal state transitions are &#42; IN_PROGRESS -> 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
*/
state?: string;
/**
* 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
*/
stepId?: string;
/** An execution of a test runner. */
testExecutionStep?: TestExecutionStep;
/** An execution of a tool (used for steps we don't explicitly support). */
toolExecutionStep?: ToolExecutionStep;
}
interface StepDimensionValueEntry {
key?: string;
value?: string;
}
interface StepLabelsEntry {
key?: string;
value?: string;
}
interface SuccessDetail {
/** If a native process other than the app crashed. */
otherNativeCrash?: boolean;
}
interface TestCaseReference {
/** The name of the class. */
className?: string;
/**
* The name of the test case.
*
* Required.
*/
name?: string;
/** The name of the test suite to which this test case belongs. */
testSuiteName?: string;
}
interface TestExecutionStep {
/**
* 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
*/
testIssues?: TestIssue[];
/**
* 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)
*/
testSuiteOverviews?: TestSuiteOverview[];
/**
* The timing break down of the test execution.
*
* - In response: present if set by create or update - In create/update request: optional
*/
testTiming?: TestTiming;
/**
* 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
*/
toolExecution?: ToolExecution;
}
interface TestIssue {
/** A brief human-readable message describing the issue. Required. */
errorMessage?: string;
/** Severity of issue. Required. */
severity?: string;
/** Deprecated in favor of stack trace fields inside specific warnings. */
stackTrace?: StackTrace;
/** Type of issue. Required. */
type?: string;
/** Warning message with additional details of the issue. Should always be a message from com.google.devtools.toolresults.v1.warnings Required. */
warning?: Any;
}
interface TestSuiteOverview {
/**
* 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
*/
errorCount?: number;
/**
* 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
*/
failureCount?: number;
/**
* The name of the test suite.
*
* - In create/response: always set - In update request: never
*/
name?: string;
/**
* 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
*/
skippedCount?: number;
/**
* Number of test cases, typically set by the service by parsing the xml_source.
*
* - In create/response: always set - In update request: never
*/
totalCount?: number;
/**
* 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
*/
xmlSource?: FileReference;
}
interface TestTiming {
/**
* How long it took to run the test process.
*
* - In response: present if previously set. - In create/update request: optional
*/
testProcessDuration?: Duration;
}
interface Thumbnail {
/**
* The thumbnail's content type, i.e. "image/png".
*
* Always set.
*/
contentType?: string;
/**
* 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.
*/
data?: string;
/**
* The height of the thumbnail, in pixels.
*
* Always set.
*/
heightPx?: number;
/**
* The width of the thumbnail, in pixels.
*
* Always set.
*/
widthPx?: number;
}
interface Timestamp {
/**
* 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.
*/
nanos?: number;
/** 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. */
seconds?: string;
}
interface ToolExecution {
/**
* 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
*/
commandLineArguments?: string[];
/**
* 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.
*/
exitCode?: ToolExitCode;
/**
* 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
*/
toolLogs?: FileReference[];
/**
* 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
*/
toolOutputs?: ToolOutputReference[];
}
interface ToolExecutionStep {
/**
* A Tool execution.
*
* - In response: present if set by create/update request - In create/update request: optional
*/
toolExecution?: ToolExecution;
}
interface ToolExitCode {
/**
* Tool execution exit code. A value of 0 means that the execution was successful.
*
* - In response: always set - In create/update request: always set
*/
number?: number;
}
interface ToolOutputReference {
/**
* The creation time of the file.
*
* - In response: present if set by create/update request - In create/update request: optional
*/
creationTime?: Timestamp;
/**
* A FileReference to an output file.
*
* - In response: always set - In create/update request: always set
*/
output?: FileReference;
/**
* The test case to which this output file belongs.
*
* - In response: present if set by create/update request - In create/update request: optional
*/
testCase?: TestCaseReference;
}
interface ClustersResource {
/** Retrieves a single screenshot cluster by its ID */
get(request: {
/** Data format for the response. */
alt?: string;
/**
* A Cluster id
*
* Required.
*/
clusterId: string;
/**
* An Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ScreenshotCluster>;
/**
* 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.
*/
list(request: {
/** Data format for the response. */
alt?: string;
/**
* An Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListScreenshotClustersResponse>;
}
interface PerfMetricsSummaryResource {
/**
* 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
*/
create(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<PerfMetricsSummary>;
}
interface SamplesResource {
/**
* 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
*/
batchCreate(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A sample series id */
sampleSeriesId: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<BatchCreatePerfSamplesResponse>;
/**
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** 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 */
pageSize?: number;
/** Optional, the next_page_token returned in the previous response */
pageToken?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A sample series id */
sampleSeriesId: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListPerfSamplesResponse>;
}
interface PerfSampleSeriesResource {
/**
* 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
*/
create(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<PerfSampleSeries>;
/**
* Gets a PerfSampleSeries.
*
* May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
*/
get(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A sample series id */
sampleSeriesId: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<PerfSampleSeries>;
/**
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** Specify one or more PerfMetricType values such as CPU to filter the result */
filter?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListPerfSampleSeriesResponse>;
samples: SamplesResource;
}
interface ThumbnailsResource {
/**
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/**
* An Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/**
* 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.
*/
pageSize?: number;
/**
* A continuation token to resume the query at the next item.
*
* Optional.
*/
pageToken?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A Step id.
*
* Required.
*/
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListStepThumbnailsResponse>;
}
interface StepsResource {
/**
* 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
*/
create(request: {
/** Data format for the response. */
alt?: string;
/**
* A Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A unique request ID for server to detect duplicated requests. For example, a UUID.
*
* Optional, but strongly recommended.
*/
requestId?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Step>;
/**
* 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
*/
get(request: {
/** Data format for the response. */
alt?: string;
/**
* A Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A Step id.
*
* Required.
*/
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Step>;
/**
* Retrieves a PerfMetricsSummary.
*
* May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist
*/
getPerfMetricsSummary(request: {
/** Data format for the response. */
alt?: string;
/** A tool results execution ID. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** A tool results history ID. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** The cloud project */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** A tool results step ID. */
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<PerfMetricsSummary>;
/**
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/**
* A Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/**
* 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.
*/
pageSize?: number;
/**
* A continuation token to resume the query at the next item.
*
* Optional.
*/
pageToken?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListStepsResponse>;
/**
* 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
*/
patch(request: {
/** Data format for the response. */
alt?: string;
/**
* A Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A unique request ID for server to detect duplicated requests. For example, a UUID.
*
* Optional, but strongly recommended.
*/
requestId?: string;
/**
* A Step id.
*
* Required.
*/
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Step>;
/**
* 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
*/
publishXunitXmlFiles(request: {
/** Data format for the response. */
alt?: string;
/**
* A Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A Step id. Note: This step must include a TestExecutionStep.
*
* Required.
*/
stepId: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Step>;
perfMetricsSummary: PerfMetricsSummaryResource;
perfSampleSeries: PerfSampleSeriesResource;
thumbnails: ThumbnailsResource;
}
interface ExecutionsResource {
/**
* 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
*/
create(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A unique request ID for server to detect duplicated requests. For example, a UUID.
*
* Optional, but strongly recommended.
*/
requestId?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Execution>;
/**
* 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
*/
get(request: {
/** Data format for the response. */
alt?: string;
/**
* An Execution id.
*
* Required.
*/
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Execution>;
/**
* Lists Histories for a given Project.
*
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/**
* 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.
*/
pageSize?: number;
/**
* A continuation token to resume the query at the next item.
*
* Optional.
*/
pageToken?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListExecutionsResponse>;
/**
* 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
*/
patch(request: {
/** Data format for the response. */
alt?: string;
/** Required. */
executionId: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** Required. */
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/** A Project id. Required. */
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A unique request ID for server to detect duplicated requests. For example, a UUID.
*
* Optional, but strongly recommended.
*/
requestId?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<Execution>;
clusters: ClustersResource;
steps: StepsResource;
}
interface HistoriesResource {
/**
* 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
*/
create(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/**
* A unique request ID for server to detect duplicated requests. For example, a UUID.
*
* Optional, but strongly recommended.
*/
requestId?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<History>;
/**
* 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
*/
get(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* A History id.
*
* Required.
*/
historyId: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<History>;
/**
* 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
*/
list(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/**
* If set, only return histories with the given name.
*
* Optional.
*/
filterByName?: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/**
* 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.
*/
pageSize?: number;
/**
* A continuation token to resume the query at the next item.
*
* Optional.
*/
pageToken?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ListHistoriesResponse>;
executions: ExecutionsResource;
}
interface ProjectsResource {
/**
* 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
*/
getSettings(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ProjectSettings>;
/**
* 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 90 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
*/
initializeSettings(request: {
/** Data format for the response. */
alt?: string;
/** Selector specifying which fields to include in a partial response. */
fields?: string;
/** 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. */
key?: string;
/** OAuth 2.0 token for the current user. */
oauth_token?: string;
/** Returns response with indentations and line breaks. */
prettyPrint?: boolean;
/**
* A Project id.
*
* Required.
*/
projectId: string;
/**
* 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.
* Overrides userIp if both are provided.
*/
quotaUser?: string;
/** IP address of the site where the request originates. Use this if you want to enforce per-user limits. */
userIp?: string;
}): Request<ProjectSettings>;
histories: HistoriesResource;
}
}
}
Reference in New Issue View Git Blame Copy Permalink