ToolResults

import { ToolResults } from "https://googleapis.deno.dev/v1/toolresults:v1beta3.ts";

API to publish and access results from developer tools.

class ToolResults {

constructor(client?: CredentialsClient, baseUrl?: string);

async projectsGetSettings(projectId: string): Promise<ProjectSettings>;

async projectsHistoriesCreate(

projectId: string,

req: History,

opts?: ProjectsHistoriesCreateOptions,

): Promise<History>;

async projectsHistoriesExecutionsClustersGet(

clusterId: string,

executionId: string,

historyId: string,

projectId: string,

): Promise<ScreenshotCluster>;

async projectsHistoriesExecutionsClustersList(

executionId: string,

historyId: string,

projectId: string,

): Promise<ListScreenshotClustersResponse>;

async projectsHistoriesExecutionsCreate(

historyId: string,

projectId: string,

req: Execution,

opts?: ProjectsHistoriesExecutionsCreateOptions,

): Promise<Execution>;

async projectsHistoriesExecutionsEnvironmentsGet(

environmentId: string,

executionId: string,

historyId: string,

projectId: string,

): Promise<Environment>;

async projectsHistoriesExecutionsEnvironmentsList(

executionId: string,

historyId: string,

projectId: string,

opts?: ProjectsHistoriesExecutionsEnvironmentsListOptions,

): Promise<ListEnvironmentsResponse>;

async projectsHistoriesExecutionsGet(

executionId: string,

historyId: string,

projectId: string,

): Promise<Execution>;

async projectsHistoriesExecutionsList(

historyId: string,

projectId: string,

opts?: ProjectsHistoriesExecutionsListOptions,

): Promise<ListExecutionsResponse>;

async projectsHistoriesExecutionsPatch(

executionId: string,

historyId: string,

projectId: string,

req: Execution,

opts?: ProjectsHistoriesExecutionsPatchOptions,

): Promise<Execution>;

async projectsHistoriesExecutionsStepsAccessibilityClusters(name: string, opts?: ProjectsHistoriesExecutionsStepsAccessibilityClustersOptions): Promise<ListStepAccessibilityClustersResponse>;

async projectsHistoriesExecutionsStepsCreate(

executionId: string,

historyId: string,

projectId: string,

req: Step,

opts?: ProjectsHistoriesExecutionsStepsCreateOptions,

): Promise<Step>;

async projectsHistoriesExecutionsStepsGet(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

): Promise<Step>;

async projectsHistoriesExecutionsStepsGetPerfMetricsSummary(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

): Promise<PerfMetricsSummary>;

async projectsHistoriesExecutionsStepsList(

executionId: string,

historyId: string,

projectId: string,

opts?: ProjectsHistoriesExecutionsStepsListOptions,

): Promise<ListStepsResponse>;

async projectsHistoriesExecutionsStepsPatch(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

req: Step,

opts?: ProjectsHistoriesExecutionsStepsPatchOptions,

): Promise<Step>;

async projectsHistoriesExecutionsStepsPerfMetricsSummaryCreate(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

req: PerfMetricsSummary,

): Promise<PerfMetricsSummary>;

async projectsHistoriesExecutionsStepsPerfSampleSeriesCreate(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

req: PerfSampleSeries,

): Promise<PerfSampleSeries>;

async projectsHistoriesExecutionsStepsPerfSampleSeriesGet(

executionId: string,

historyId: string,

projectId: string,

sampleSeriesId: string,

stepId: string,

): Promise<PerfSampleSeries>;

async projectsHistoriesExecutionsStepsPerfSampleSeriesList(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

opts?: ProjectsHistoriesExecutionsStepsPerfSampleSeriesListOptions,

): Promise<ListPerfSampleSeriesResponse>;

async projectsHistoriesExecutionsStepsPerfSampleSeriesSamplesBatchCreate(

executionId: string,

historyId: string,

projectId: string,

sampleSeriesId: string,

stepId: string,

req: BatchCreatePerfSamplesRequest,

): Promise<BatchCreatePerfSamplesResponse>;

async projectsHistoriesExecutionsStepsPerfSampleSeriesSamplesList(

executionId: string,

historyId: string,

projectId: string,

sampleSeriesId: string,

stepId: string,

opts?: ProjectsHistoriesExecutionsStepsPerfSampleSeriesSamplesListOptions,

): Promise<ListPerfSamplesResponse>;

async projectsHistoriesExecutionsStepsPublishXunitXmlFiles(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

req: PublishXunitXmlFilesRequest,

): Promise<Step>;

async projectsHistoriesExecutionsStepsTestCasesGet(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

testCaseId: string,

): Promise<TestCase>;

async projectsHistoriesExecutionsStepsTestCasesList(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

opts?: ProjectsHistoriesExecutionsStepsTestCasesListOptions,

): Promise<ListTestCasesResponse>;

async projectsHistoriesExecutionsStepsThumbnailsList(

executionId: string,

historyId: string,

projectId: string,

stepId: string,

opts?: ProjectsHistoriesExecutionsStepsThumbnailsListOptions,

): Promise<ListStepThumbnailsResponse>;

async projectsHistoriesGet(historyId: string, projectId: string): Promise<History>;

async projectsHistoriesList(projectId: string, opts?: ProjectsHistoriesListOptions): Promise<ListHistoriesResponse>;

async projectsInitializeSettings(projectId: string): Promise<ProjectSettings>;

}

§Constructors

new ToolResults(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

projectsGetSettings(projectId: string): Promise<ProjectSettings>

[src]

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

@param projectId

A Project id. Required.

projectsHistoriesCreate(projectId: string, req: History, opts?: ProjectsHistoriesCreateOptions): Promise<History>

[src]

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

@param projectId

A Project id. Required.

projectsHistoriesExecutionsClustersGet(clusterId: string, executionId: string, historyId: string, projectId: string): Promise<ScreenshotCluster>

[src]

Retrieves a single screenshot cluster by its ID

@param clusterId

A Cluster id Required.

@param executionId

An Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsClustersList(executionId: string, historyId: string, projectId: string): Promise<ListScreenshotClustersResponse>

[src]

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.

@param executionId

An Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsCreate(historyId: string, projectId: string, req: Execution, opts?: ProjectsHistoriesExecutionsCreateOptions): Promise<Execution>

[src]

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

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsEnvironmentsGet(environmentId: string, executionId: string, historyId: string, projectId: string): Promise<Environment>

[src]

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

@param environmentId

Required. An Environment id.

@param executionId

Required. An Execution id.

@param historyId

Required. A History id.

@param projectId

Required. A Project id.

projectsHistoriesExecutionsEnvironmentsList(executionId: string, historyId: string, projectId: string, opts?: ProjectsHistoriesExecutionsEnvironmentsListOptions): Promise<ListEnvironmentsResponse>

[src]

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

@param executionId

Required. An Execution id.

@param historyId

Required. A History id.

@param projectId

Required. A Project id.

projectsHistoriesExecutionsGet(executionId: string, historyId: string, projectId: string): Promise<Execution>

[src]

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

@param executionId

An Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsList(historyId: string, projectId: string, opts?: ProjectsHistoriesExecutionsListOptions): Promise<ListExecutionsResponse>

[src]

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

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsPatch(executionId: string, historyId: string, projectId: string, req: Execution, opts?: ProjectsHistoriesExecutionsPatchOptions): Promise<Execution>

[src]

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

@param executionId

Required.

@param historyId

Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsStepsAccessibilityClusters(name: string, opts?: ProjectsHistoriesExecutionsStepsAccessibilityClustersOptions): Promise<ListStepAccessibilityClustersResponse>

[src]

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

@param name

A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.

projectsHistoriesExecutionsStepsCreate(executionId: string, historyId: string, projectId: string, req: Step, opts?: ProjectsHistoriesExecutionsStepsCreateOptions): Promise<Step>

[src]

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

@param executionId

Required. An Execution id.

@param historyId

Required. A History id.

@param projectId

Required. A Project id.

projectsHistoriesExecutionsStepsGet(executionId: string, historyId: string, projectId: string, stepId: string): Promise<Step>

[src]

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

@param executionId

A Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Required.

projectsHistoriesExecutionsStepsGetPerfMetricsSummary(executionId: string, historyId: string, projectId: string, stepId: string): Promise<PerfMetricsSummary>

[src]

Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsList(executionId: string, historyId: string, projectId: string, opts?: ProjectsHistoriesExecutionsStepsListOptions): Promise<ListStepsResponse>

[src]

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

@param executionId

A Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesExecutionsStepsPatch(executionId: string, historyId: string, projectId: string, stepId: string, req: Step, opts?: ProjectsHistoriesExecutionsStepsPatchOptions): Promise<Step>

[src]

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

@param executionId

A Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Required.

projectsHistoriesExecutionsStepsPerfMetricsSummaryCreate(executionId: string, historyId: string, projectId: string, stepId: string, req: PerfMetricsSummary): Promise<PerfMetricsSummary>

[src]

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

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPerfSampleSeriesCreate(executionId: string, historyId: string, projectId: string, stepId: string, req: PerfSampleSeries): Promise<PerfSampleSeries>

[src]

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

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPerfSampleSeriesGet(executionId: string, historyId: string, projectId: string, sampleSeriesId: string, stepId: string): Promise<PerfSampleSeries>

[src]

Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param sampleSeriesId

A sample series id

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPerfSampleSeriesList(executionId: string, historyId: string, projectId: string, stepId: string, opts?: ProjectsHistoriesExecutionsStepsPerfSampleSeriesListOptions): Promise<ListPerfSampleSeriesResponse>

[src]

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

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPerfSampleSeriesSamplesBatchCreate(executionId: string, historyId: string, projectId: string, sampleSeriesId: string, stepId: string, req: BatchCreatePerfSamplesRequest): Promise<BatchCreatePerfSamplesResponse>

[src]

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

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param sampleSeriesId

A sample series id

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPerfSampleSeriesSamplesList(executionId: string, historyId: string, projectId: string, sampleSeriesId: string, stepId: string, opts?: ProjectsHistoriesExecutionsStepsPerfSampleSeriesSamplesListOptions): Promise<ListPerfSamplesResponse>

[src]

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

@param executionId

A tool results execution ID.

@param historyId

A tool results history ID.

@param projectId

The cloud project

@param sampleSeriesId

A sample series id

@param stepId

A tool results step ID.

projectsHistoriesExecutionsStepsPublishXunitXmlFiles(executionId: string, historyId: string, projectId: string, stepId: string, req: PublishXunitXmlFilesRequest): Promise<Step>

[src]

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

@param executionId

A Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Note: This step must include a TestExecutionStep. Required.

projectsHistoriesExecutionsStepsTestCasesGet(executionId: string, historyId: string, projectId: string, stepId: string, testCaseId: string): Promise<TestCase>

[src]

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

@param executionId

A Execution id Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Note: This step must include a TestExecutionStep. Required.

@param testCaseId

A Test Case id. Required.

projectsHistoriesExecutionsStepsTestCasesList(executionId: string, historyId: string, projectId: string, stepId: string, opts?: ProjectsHistoriesExecutionsStepsTestCasesListOptions): Promise<ListTestCasesResponse>

[src]

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

@param executionId

A Execution id Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Note: This step must include a TestExecutionStep. Required.

projectsHistoriesExecutionsStepsThumbnailsList(executionId: string, historyId: string, projectId: string, stepId: string, opts?: ProjectsHistoriesExecutionsStepsThumbnailsListOptions): Promise<ListStepThumbnailsResponse>

[src]

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

@param executionId

An Execution id. Required.

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

@param stepId

A Step id. Required.

projectsHistoriesGet(historyId: string, projectId: string): Promise<History>

[src]

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

@param historyId

A History id. Required.

@param projectId

A Project id. Required.

projectsHistoriesList(projectId: string, opts?: ProjectsHistoriesListOptions): Promise<ListHistoriesResponse>

[src]

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

@param projectId

A Project id. Required.

projectsInitializeSettings(projectId: string): Promise<ProjectSettings>

[src]

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

@param projectId

A Project id. Required.