@googleapis/toolresults 4.0.1 → 6.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,3 @@
1
- /// <reference types="node" />
2
1
  import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
3
2
  import { Readable } from 'stream';
4
3
  export declare namespace toolresults_v1beta3 {
@@ -1752,6 +1751,53 @@ export declare namespace toolresults_v1beta3 {
1752
1751
  constructor(context: APIRequestContext);
1753
1752
  /**
1754
1753
  * 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
1754
+ * @example
1755
+ * ```js
1756
+ * // Before running the sample:
1757
+ * // - Enable the API at:
1758
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1759
+ * // - Login into gcloud by running:
1760
+ * // ```sh
1761
+ * // $ gcloud auth application-default login
1762
+ * // ```
1763
+ * // - Install the npm module by running:
1764
+ * // ```sh
1765
+ * // $ npm install googleapis
1766
+ * // ```
1767
+ *
1768
+ * const {google} = require('googleapis');
1769
+ * const toolresults = google.toolresults('v1beta3');
1770
+ *
1771
+ * async function main() {
1772
+ * const auth = new google.auth.GoogleAuth({
1773
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1774
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1775
+ * });
1776
+ *
1777
+ * // Acquire an auth client, and bind it to all future calls
1778
+ * const authClient = await auth.getClient();
1779
+ * google.options({auth: authClient});
1780
+ *
1781
+ * // Do the magic
1782
+ * const res = await toolresults.projects.getSettings({
1783
+ * // A Project id. Required.
1784
+ * projectId: 'placeholder-value',
1785
+ * });
1786
+ * console.log(res.data);
1787
+ *
1788
+ * // Example response
1789
+ * // {
1790
+ * // "defaultBucket": "my_defaultBucket",
1791
+ * // "name": "my_name"
1792
+ * // }
1793
+ * }
1794
+ *
1795
+ * main().catch(e => {
1796
+ * console.error(e);
1797
+ * throw e;
1798
+ * });
1799
+ *
1800
+ * ```
1755
1801
  *
1756
1802
  * @param params - Parameters for request
1757
1803
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1766,6 +1812,53 @@ export declare namespace toolresults_v1beta3 {
1766
1812
  getSettings(callback: BodyResponseCallback<Schema$ProjectSettings>): void;
1767
1813
  /**
1768
1814
  * 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
1815
+ * @example
1816
+ * ```js
1817
+ * // Before running the sample:
1818
+ * // - Enable the API at:
1819
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1820
+ * // - Login into gcloud by running:
1821
+ * // ```sh
1822
+ * // $ gcloud auth application-default login
1823
+ * // ```
1824
+ * // - Install the npm module by running:
1825
+ * // ```sh
1826
+ * // $ npm install googleapis
1827
+ * // ```
1828
+ *
1829
+ * const {google} = require('googleapis');
1830
+ * const toolresults = google.toolresults('v1beta3');
1831
+ *
1832
+ * async function main() {
1833
+ * const auth = new google.auth.GoogleAuth({
1834
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1835
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1836
+ * });
1837
+ *
1838
+ * // Acquire an auth client, and bind it to all future calls
1839
+ * const authClient = await auth.getClient();
1840
+ * google.options({auth: authClient});
1841
+ *
1842
+ * // Do the magic
1843
+ * const res = await toolresults.projects.initializeSettings({
1844
+ * // A Project id. Required.
1845
+ * projectId: 'placeholder-value',
1846
+ * });
1847
+ * console.log(res.data);
1848
+ *
1849
+ * // Example response
1850
+ * // {
1851
+ * // "defaultBucket": "my_defaultBucket",
1852
+ * // "name": "my_name"
1853
+ * // }
1854
+ * }
1855
+ *
1856
+ * main().catch(e => {
1857
+ * console.error(e);
1858
+ * throw e;
1859
+ * });
1860
+ *
1861
+ * ```
1769
1862
  *
1770
1863
  * @param params - Parameters for request
1771
1864
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1797,6 +1890,68 @@ export declare namespace toolresults_v1beta3 {
1797
1890
  constructor(context: APIRequestContext);
1798
1891
  /**
1799
1892
  * 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
1893
+ * @example
1894
+ * ```js
1895
+ * // Before running the sample:
1896
+ * // - Enable the API at:
1897
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1898
+ * // - Login into gcloud by running:
1899
+ * // ```sh
1900
+ * // $ gcloud auth application-default login
1901
+ * // ```
1902
+ * // - Install the npm module by running:
1903
+ * // ```sh
1904
+ * // $ npm install googleapis
1905
+ * // ```
1906
+ *
1907
+ * const {google} = require('googleapis');
1908
+ * const toolresults = google.toolresults('v1beta3');
1909
+ *
1910
+ * async function main() {
1911
+ * const auth = new google.auth.GoogleAuth({
1912
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1913
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1914
+ * });
1915
+ *
1916
+ * // Acquire an auth client, and bind it to all future calls
1917
+ * const authClient = await auth.getClient();
1918
+ * google.options({auth: authClient});
1919
+ *
1920
+ * // Do the magic
1921
+ * const res = await toolresults.projects.histories.create({
1922
+ * // A Project id. Required.
1923
+ * projectId: 'placeholder-value',
1924
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
1925
+ * requestId: 'placeholder-value',
1926
+ *
1927
+ * // Request body metadata
1928
+ * requestBody: {
1929
+ * // request body parameters
1930
+ * // {
1931
+ * // "displayName": "my_displayName",
1932
+ * // "historyId": "my_historyId",
1933
+ * // "name": "my_name",
1934
+ * // "testPlatform": "my_testPlatform"
1935
+ * // }
1936
+ * },
1937
+ * });
1938
+ * console.log(res.data);
1939
+ *
1940
+ * // Example response
1941
+ * // {
1942
+ * // "displayName": "my_displayName",
1943
+ * // "historyId": "my_historyId",
1944
+ * // "name": "my_name",
1945
+ * // "testPlatform": "my_testPlatform"
1946
+ * // }
1947
+ * }
1948
+ *
1949
+ * main().catch(e => {
1950
+ * console.error(e);
1951
+ * throw e;
1952
+ * });
1953
+ *
1954
+ * ```
1800
1955
  *
1801
1956
  * @param params - Parameters for request
1802
1957
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1811,6 +1966,57 @@ export declare namespace toolresults_v1beta3 {
1811
1966
  create(callback: BodyResponseCallback<Schema$History>): void;
1812
1967
  /**
1813
1968
  * 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
1969
+ * @example
1970
+ * ```js
1971
+ * // Before running the sample:
1972
+ * // - Enable the API at:
1973
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1974
+ * // - Login into gcloud by running:
1975
+ * // ```sh
1976
+ * // $ gcloud auth application-default login
1977
+ * // ```
1978
+ * // - Install the npm module by running:
1979
+ * // ```sh
1980
+ * // $ npm install googleapis
1981
+ * // ```
1982
+ *
1983
+ * const {google} = require('googleapis');
1984
+ * const toolresults = google.toolresults('v1beta3');
1985
+ *
1986
+ * async function main() {
1987
+ * const auth = new google.auth.GoogleAuth({
1988
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1989
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1990
+ * });
1991
+ *
1992
+ * // Acquire an auth client, and bind it to all future calls
1993
+ * const authClient = await auth.getClient();
1994
+ * google.options({auth: authClient});
1995
+ *
1996
+ * // Do the magic
1997
+ * const res = await toolresults.projects.histories.get({
1998
+ * // A History id. Required.
1999
+ * historyId: 'placeholder-value',
2000
+ * // A Project id. Required.
2001
+ * projectId: 'placeholder-value',
2002
+ * });
2003
+ * console.log(res.data);
2004
+ *
2005
+ * // Example response
2006
+ * // {
2007
+ * // "displayName": "my_displayName",
2008
+ * // "historyId": "my_historyId",
2009
+ * // "name": "my_name",
2010
+ * // "testPlatform": "my_testPlatform"
2011
+ * // }
2012
+ * }
2013
+ *
2014
+ * main().catch(e => {
2015
+ * console.error(e);
2016
+ * throw e;
2017
+ * });
2018
+ *
2019
+ * ```
1814
2020
  *
1815
2021
  * @param params - Parameters for request
1816
2022
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1825,6 +2031,59 @@ export declare namespace toolresults_v1beta3 {
1825
2031
  get(callback: BodyResponseCallback<Schema$History>): void;
1826
2032
  /**
1827
2033
  * 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
2034
+ * @example
2035
+ * ```js
2036
+ * // Before running the sample:
2037
+ * // - Enable the API at:
2038
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2039
+ * // - Login into gcloud by running:
2040
+ * // ```sh
2041
+ * // $ gcloud auth application-default login
2042
+ * // ```
2043
+ * // - Install the npm module by running:
2044
+ * // ```sh
2045
+ * // $ npm install googleapis
2046
+ * // ```
2047
+ *
2048
+ * const {google} = require('googleapis');
2049
+ * const toolresults = google.toolresults('v1beta3');
2050
+ *
2051
+ * async function main() {
2052
+ * const auth = new google.auth.GoogleAuth({
2053
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2054
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2055
+ * });
2056
+ *
2057
+ * // Acquire an auth client, and bind it to all future calls
2058
+ * const authClient = await auth.getClient();
2059
+ * google.options({auth: authClient});
2060
+ *
2061
+ * // Do the magic
2062
+ * const res = await toolresults.projects.histories.list({
2063
+ * // If set, only return histories with the given name. Optional.
2064
+ * filterByName: 'placeholder-value',
2065
+ * // 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.
2066
+ * pageSize: 'placeholder-value',
2067
+ * // A continuation token to resume the query at the next item. Optional.
2068
+ * pageToken: 'placeholder-value',
2069
+ * // A Project id. Required.
2070
+ * projectId: 'placeholder-value',
2071
+ * });
2072
+ * console.log(res.data);
2073
+ *
2074
+ * // Example response
2075
+ * // {
2076
+ * // "histories": [],
2077
+ * // "nextPageToken": "my_nextPageToken"
2078
+ * // }
2079
+ * }
2080
+ *
2081
+ * main().catch(e => {
2082
+ * console.error(e);
2083
+ * throw e;
2084
+ * });
2085
+ *
2086
+ * ```
1828
2087
  *
1829
2088
  * @param params - Parameters for request
1830
2089
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1888,6 +2147,78 @@ export declare namespace toolresults_v1beta3 {
1888
2147
  constructor(context: APIRequestContext);
1889
2148
  /**
1890
2149
  * 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
2150
+ * @example
2151
+ * ```js
2152
+ * // Before running the sample:
2153
+ * // - Enable the API at:
2154
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2155
+ * // - Login into gcloud by running:
2156
+ * // ```sh
2157
+ * // $ gcloud auth application-default login
2158
+ * // ```
2159
+ * // - Install the npm module by running:
2160
+ * // ```sh
2161
+ * // $ npm install googleapis
2162
+ * // ```
2163
+ *
2164
+ * const {google} = require('googleapis');
2165
+ * const toolresults = google.toolresults('v1beta3');
2166
+ *
2167
+ * async function main() {
2168
+ * const auth = new google.auth.GoogleAuth({
2169
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2170
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2171
+ * });
2172
+ *
2173
+ * // Acquire an auth client, and bind it to all future calls
2174
+ * const authClient = await auth.getClient();
2175
+ * google.options({auth: authClient});
2176
+ *
2177
+ * // Do the magic
2178
+ * const res = await toolresults.projects.histories.executions.create({
2179
+ * // A History id. Required.
2180
+ * historyId: 'placeholder-value',
2181
+ * // A Project id. Required.
2182
+ * projectId: 'placeholder-value',
2183
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
2184
+ * requestId: 'placeholder-value',
2185
+ *
2186
+ * // Request body metadata
2187
+ * requestBody: {
2188
+ * // request body parameters
2189
+ * // {
2190
+ * // "completionTime": {},
2191
+ * // "creationTime": {},
2192
+ * // "dimensionDefinitions": [],
2193
+ * // "executionId": "my_executionId",
2194
+ * // "outcome": {},
2195
+ * // "specification": {},
2196
+ * // "state": "my_state",
2197
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2198
+ * // }
2199
+ * },
2200
+ * });
2201
+ * console.log(res.data);
2202
+ *
2203
+ * // Example response
2204
+ * // {
2205
+ * // "completionTime": {},
2206
+ * // "creationTime": {},
2207
+ * // "dimensionDefinitions": [],
2208
+ * // "executionId": "my_executionId",
2209
+ * // "outcome": {},
2210
+ * // "specification": {},
2211
+ * // "state": "my_state",
2212
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2213
+ * // }
2214
+ * }
2215
+ *
2216
+ * main().catch(e => {
2217
+ * console.error(e);
2218
+ * throw e;
2219
+ * });
2220
+ *
2221
+ * ```
1891
2222
  *
1892
2223
  * @param params - Parameters for request
1893
2224
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1902,6 +2233,63 @@ export declare namespace toolresults_v1beta3 {
1902
2233
  create(callback: BodyResponseCallback<Schema$Execution>): void;
1903
2234
  /**
1904
2235
  * 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
2236
+ * @example
2237
+ * ```js
2238
+ * // Before running the sample:
2239
+ * // - Enable the API at:
2240
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2241
+ * // - Login into gcloud by running:
2242
+ * // ```sh
2243
+ * // $ gcloud auth application-default login
2244
+ * // ```
2245
+ * // - Install the npm module by running:
2246
+ * // ```sh
2247
+ * // $ npm install googleapis
2248
+ * // ```
2249
+ *
2250
+ * const {google} = require('googleapis');
2251
+ * const toolresults = google.toolresults('v1beta3');
2252
+ *
2253
+ * async function main() {
2254
+ * const auth = new google.auth.GoogleAuth({
2255
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2256
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2257
+ * });
2258
+ *
2259
+ * // Acquire an auth client, and bind it to all future calls
2260
+ * const authClient = await auth.getClient();
2261
+ * google.options({auth: authClient});
2262
+ *
2263
+ * // Do the magic
2264
+ * const res = await toolresults.projects.histories.executions.get({
2265
+ * // An Execution id. Required.
2266
+ * executionId: 'placeholder-value',
2267
+ * // A History id. Required.
2268
+ * historyId: 'placeholder-value',
2269
+ * // A Project id. Required.
2270
+ * projectId: 'placeholder-value',
2271
+ * });
2272
+ * console.log(res.data);
2273
+ *
2274
+ * // Example response
2275
+ * // {
2276
+ * // "completionTime": {},
2277
+ * // "creationTime": {},
2278
+ * // "dimensionDefinitions": [],
2279
+ * // "executionId": "my_executionId",
2280
+ * // "outcome": {},
2281
+ * // "specification": {},
2282
+ * // "state": "my_state",
2283
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2284
+ * // }
2285
+ * }
2286
+ *
2287
+ * main().catch(e => {
2288
+ * console.error(e);
2289
+ * throw e;
2290
+ * });
2291
+ *
2292
+ * ```
1905
2293
  *
1906
2294
  * @param params - Parameters for request
1907
2295
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1916,6 +2304,59 @@ export declare namespace toolresults_v1beta3 {
1916
2304
  get(callback: BodyResponseCallback<Schema$Execution>): void;
1917
2305
  /**
1918
2306
  * 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
2307
+ * @example
2308
+ * ```js
2309
+ * // Before running the sample:
2310
+ * // - Enable the API at:
2311
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2312
+ * // - Login into gcloud by running:
2313
+ * // ```sh
2314
+ * // $ gcloud auth application-default login
2315
+ * // ```
2316
+ * // - Install the npm module by running:
2317
+ * // ```sh
2318
+ * // $ npm install googleapis
2319
+ * // ```
2320
+ *
2321
+ * const {google} = require('googleapis');
2322
+ * const toolresults = google.toolresults('v1beta3');
2323
+ *
2324
+ * async function main() {
2325
+ * const auth = new google.auth.GoogleAuth({
2326
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2327
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2328
+ * });
2329
+ *
2330
+ * // Acquire an auth client, and bind it to all future calls
2331
+ * const authClient = await auth.getClient();
2332
+ * google.options({auth: authClient});
2333
+ *
2334
+ * // Do the magic
2335
+ * const res = await toolresults.projects.histories.executions.list({
2336
+ * // A History id. Required.
2337
+ * historyId: 'placeholder-value',
2338
+ * // 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.
2339
+ * pageSize: 'placeholder-value',
2340
+ * // A continuation token to resume the query at the next item. Optional.
2341
+ * pageToken: 'placeholder-value',
2342
+ * // A Project id. Required.
2343
+ * projectId: 'placeholder-value',
2344
+ * });
2345
+ * console.log(res.data);
2346
+ *
2347
+ * // Example response
2348
+ * // {
2349
+ * // "executions": [],
2350
+ * // "nextPageToken": "my_nextPageToken"
2351
+ * // }
2352
+ * }
2353
+ *
2354
+ * main().catch(e => {
2355
+ * console.error(e);
2356
+ * throw e;
2357
+ * });
2358
+ *
2359
+ * ```
1919
2360
  *
1920
2361
  * @param params - Parameters for request
1921
2362
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1930,6 +2371,80 @@ export declare namespace toolresults_v1beta3 {
1930
2371
  list(callback: BodyResponseCallback<Schema$ListExecutionsResponse>): void;
1931
2372
  /**
1932
2373
  * 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
2374
+ * @example
2375
+ * ```js
2376
+ * // Before running the sample:
2377
+ * // - Enable the API at:
2378
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2379
+ * // - Login into gcloud by running:
2380
+ * // ```sh
2381
+ * // $ gcloud auth application-default login
2382
+ * // ```
2383
+ * // - Install the npm module by running:
2384
+ * // ```sh
2385
+ * // $ npm install googleapis
2386
+ * // ```
2387
+ *
2388
+ * const {google} = require('googleapis');
2389
+ * const toolresults = google.toolresults('v1beta3');
2390
+ *
2391
+ * async function main() {
2392
+ * const auth = new google.auth.GoogleAuth({
2393
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2394
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2395
+ * });
2396
+ *
2397
+ * // Acquire an auth client, and bind it to all future calls
2398
+ * const authClient = await auth.getClient();
2399
+ * google.options({auth: authClient});
2400
+ *
2401
+ * // Do the magic
2402
+ * const res = await toolresults.projects.histories.executions.patch({
2403
+ * // Required.
2404
+ * executionId: 'placeholder-value',
2405
+ * // Required.
2406
+ * historyId: 'placeholder-value',
2407
+ * // A Project id. Required.
2408
+ * projectId: 'placeholder-value',
2409
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
2410
+ * requestId: 'placeholder-value',
2411
+ *
2412
+ * // Request body metadata
2413
+ * requestBody: {
2414
+ * // request body parameters
2415
+ * // {
2416
+ * // "completionTime": {},
2417
+ * // "creationTime": {},
2418
+ * // "dimensionDefinitions": [],
2419
+ * // "executionId": "my_executionId",
2420
+ * // "outcome": {},
2421
+ * // "specification": {},
2422
+ * // "state": "my_state",
2423
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2424
+ * // }
2425
+ * },
2426
+ * });
2427
+ * console.log(res.data);
2428
+ *
2429
+ * // Example response
2430
+ * // {
2431
+ * // "completionTime": {},
2432
+ * // "creationTime": {},
2433
+ * // "dimensionDefinitions": [],
2434
+ * // "executionId": "my_executionId",
2435
+ * // "outcome": {},
2436
+ * // "specification": {},
2437
+ * // "state": "my_state",
2438
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2439
+ * // }
2440
+ * }
2441
+ *
2442
+ * main().catch(e => {
2443
+ * console.error(e);
2444
+ * throw e;
2445
+ * });
2446
+ *
2447
+ * ```
1933
2448
  *
1934
2449
  * @param params - Parameters for request
1935
2450
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2020,6 +2535,61 @@ export declare namespace toolresults_v1beta3 {
2020
2535
  constructor(context: APIRequestContext);
2021
2536
  /**
2022
2537
  * Retrieves a single screenshot cluster by its ID
2538
+ * @example
2539
+ * ```js
2540
+ * // Before running the sample:
2541
+ * // - Enable the API at:
2542
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2543
+ * // - Login into gcloud by running:
2544
+ * // ```sh
2545
+ * // $ gcloud auth application-default login
2546
+ * // ```
2547
+ * // - Install the npm module by running:
2548
+ * // ```sh
2549
+ * // $ npm install googleapis
2550
+ * // ```
2551
+ *
2552
+ * const {google} = require('googleapis');
2553
+ * const toolresults = google.toolresults('v1beta3');
2554
+ *
2555
+ * async function main() {
2556
+ * const auth = new google.auth.GoogleAuth({
2557
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2558
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2559
+ * });
2560
+ *
2561
+ * // Acquire an auth client, and bind it to all future calls
2562
+ * const authClient = await auth.getClient();
2563
+ * google.options({auth: authClient});
2564
+ *
2565
+ * // Do the magic
2566
+ * const res = await toolresults.projects.histories.executions.clusters.get({
2567
+ * // A Cluster id Required.
2568
+ * clusterId: 'placeholder-value',
2569
+ * // An Execution id. Required.
2570
+ * executionId: 'placeholder-value',
2571
+ * // A History id. Required.
2572
+ * historyId: 'placeholder-value',
2573
+ * // A Project id. Required.
2574
+ * projectId: 'placeholder-value',
2575
+ * });
2576
+ * console.log(res.data);
2577
+ *
2578
+ * // Example response
2579
+ * // {
2580
+ * // "activity": "my_activity",
2581
+ * // "clusterId": "my_clusterId",
2582
+ * // "keyScreen": {},
2583
+ * // "screens": []
2584
+ * // }
2585
+ * }
2586
+ *
2587
+ * main().catch(e => {
2588
+ * console.error(e);
2589
+ * throw e;
2590
+ * });
2591
+ *
2592
+ * ```
2023
2593
  *
2024
2594
  * @param params - Parameters for request
2025
2595
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2034,6 +2604,56 @@ export declare namespace toolresults_v1beta3 {
2034
2604
  get(callback: BodyResponseCallback<Schema$ScreenshotCluster>): void;
2035
2605
  /**
2036
2606
  * 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.
2607
+ * @example
2608
+ * ```js
2609
+ * // Before running the sample:
2610
+ * // - Enable the API at:
2611
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2612
+ * // - Login into gcloud by running:
2613
+ * // ```sh
2614
+ * // $ gcloud auth application-default login
2615
+ * // ```
2616
+ * // - Install the npm module by running:
2617
+ * // ```sh
2618
+ * // $ npm install googleapis
2619
+ * // ```
2620
+ *
2621
+ * const {google} = require('googleapis');
2622
+ * const toolresults = google.toolresults('v1beta3');
2623
+ *
2624
+ * async function main() {
2625
+ * const auth = new google.auth.GoogleAuth({
2626
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2627
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2628
+ * });
2629
+ *
2630
+ * // Acquire an auth client, and bind it to all future calls
2631
+ * const authClient = await auth.getClient();
2632
+ * google.options({auth: authClient});
2633
+ *
2634
+ * // Do the magic
2635
+ * const res = await toolresults.projects.histories.executions.clusters.list({
2636
+ * // An Execution id. Required.
2637
+ * executionId: 'placeholder-value',
2638
+ * // A History id. Required.
2639
+ * historyId: 'placeholder-value',
2640
+ * // A Project id. Required.
2641
+ * projectId: 'placeholder-value',
2642
+ * });
2643
+ * console.log(res.data);
2644
+ *
2645
+ * // Example response
2646
+ * // {
2647
+ * // "clusters": []
2648
+ * // }
2649
+ * }
2650
+ *
2651
+ * main().catch(e => {
2652
+ * console.error(e);
2653
+ * throw e;
2654
+ * });
2655
+ *
2656
+ * ```
2037
2657
  *
2038
2658
  * @param params - Parameters for request
2039
2659
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2084,6 +2704,68 @@ export declare namespace toolresults_v1beta3 {
2084
2704
  constructor(context: APIRequestContext);
2085
2705
  /**
2086
2706
  * 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
2707
+ * @example
2708
+ * ```js
2709
+ * // Before running the sample:
2710
+ * // - Enable the API at:
2711
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2712
+ * // - Login into gcloud by running:
2713
+ * // ```sh
2714
+ * // $ gcloud auth application-default login
2715
+ * // ```
2716
+ * // - Install the npm module by running:
2717
+ * // ```sh
2718
+ * // $ npm install googleapis
2719
+ * // ```
2720
+ *
2721
+ * const {google} = require('googleapis');
2722
+ * const toolresults = google.toolresults('v1beta3');
2723
+ *
2724
+ * async function main() {
2725
+ * const auth = new google.auth.GoogleAuth({
2726
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2727
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2728
+ * });
2729
+ *
2730
+ * // Acquire an auth client, and bind it to all future calls
2731
+ * const authClient = await auth.getClient();
2732
+ * google.options({auth: authClient});
2733
+ *
2734
+ * // Do the magic
2735
+ * const res = await toolresults.projects.histories.executions.environments.get({
2736
+ * // Required. An Environment id.
2737
+ * environmentId: 'placeholder-value',
2738
+ * // Required. An Execution id.
2739
+ * executionId: 'placeholder-value',
2740
+ * // Required. A History id.
2741
+ * historyId: 'placeholder-value',
2742
+ * // Required. A Project id.
2743
+ * projectId: 'placeholder-value',
2744
+ * });
2745
+ * console.log(res.data);
2746
+ *
2747
+ * // Example response
2748
+ * // {
2749
+ * // "completionTime": {},
2750
+ * // "creationTime": {},
2751
+ * // "dimensionValue": [],
2752
+ * // "displayName": "my_displayName",
2753
+ * // "environmentId": "my_environmentId",
2754
+ * // "environmentResult": {},
2755
+ * // "executionId": "my_executionId",
2756
+ * // "historyId": "my_historyId",
2757
+ * // "projectId": "my_projectId",
2758
+ * // "resultsStorage": {},
2759
+ * // "shardSummaries": []
2760
+ * // }
2761
+ * }
2762
+ *
2763
+ * main().catch(e => {
2764
+ * console.error(e);
2765
+ * throw e;
2766
+ * });
2767
+ *
2768
+ * ```
2087
2769
  *
2088
2770
  * @param params - Parameters for request
2089
2771
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2098,6 +2780,66 @@ export declare namespace toolresults_v1beta3 {
2098
2780
  get(callback: BodyResponseCallback<Schema$Environment>): void;
2099
2781
  /**
2100
2782
  * 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
2783
+ * @example
2784
+ * ```js
2785
+ * // Before running the sample:
2786
+ * // - Enable the API at:
2787
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2788
+ * // - Login into gcloud by running:
2789
+ * // ```sh
2790
+ * // $ gcloud auth application-default login
2791
+ * // ```
2792
+ * // - Install the npm module by running:
2793
+ * // ```sh
2794
+ * // $ npm install googleapis
2795
+ * // ```
2796
+ *
2797
+ * const {google} = require('googleapis');
2798
+ * const toolresults = google.toolresults('v1beta3');
2799
+ *
2800
+ * async function main() {
2801
+ * const auth = new google.auth.GoogleAuth({
2802
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2803
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2804
+ * });
2805
+ *
2806
+ * // Acquire an auth client, and bind it to all future calls
2807
+ * const authClient = await auth.getClient();
2808
+ * google.options({auth: authClient});
2809
+ *
2810
+ * // Do the magic
2811
+ * const res = await toolresults.projects.histories.executions.environments.list(
2812
+ * {
2813
+ * // Required. An Execution id.
2814
+ * executionId: 'placeholder-value',
2815
+ * // Required. A History id.
2816
+ * historyId: 'placeholder-value',
2817
+ * // The maximum number of Environments to fetch. Default value: 25. The server will use this default if the field is not set or has a value of 0.
2818
+ * pageSize: 'placeholder-value',
2819
+ * // A continuation token to resume the query at the next item.
2820
+ * pageToken: 'placeholder-value',
2821
+ * // Required. A Project id.
2822
+ * projectId: 'placeholder-value',
2823
+ * },
2824
+ * );
2825
+ * console.log(res.data);
2826
+ *
2827
+ * // Example response
2828
+ * // {
2829
+ * // "environments": [],
2830
+ * // "executionId": "my_executionId",
2831
+ * // "historyId": "my_historyId",
2832
+ * // "nextPageToken": "my_nextPageToken",
2833
+ * // "projectId": "my_projectId"
2834
+ * // }
2835
+ * }
2836
+ *
2837
+ * main().catch(e => {
2838
+ * console.error(e);
2839
+ * throw e;
2840
+ * });
2841
+ *
2842
+ * ```
2101
2843
  *
2102
2844
  * @param params - Parameters for request
2103
2845
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2160,6 +2902,58 @@ export declare namespace toolresults_v1beta3 {
2160
2902
  constructor(context: APIRequestContext);
2161
2903
  /**
2162
2904
  * 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
2905
+ * @example
2906
+ * ```js
2907
+ * // Before running the sample:
2908
+ * // - Enable the API at:
2909
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2910
+ * // - Login into gcloud by running:
2911
+ * // ```sh
2912
+ * // $ gcloud auth application-default login
2913
+ * // ```
2914
+ * // - Install the npm module by running:
2915
+ * // ```sh
2916
+ * // $ npm install googleapis
2917
+ * // ```
2918
+ *
2919
+ * const {google} = require('googleapis');
2920
+ * const toolresults = google.toolresults('v1beta3');
2921
+ *
2922
+ * async function main() {
2923
+ * const auth = new google.auth.GoogleAuth({
2924
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2925
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2926
+ * });
2927
+ *
2928
+ * // Acquire an auth client, and bind it to all future calls
2929
+ * const authClient = await auth.getClient();
2930
+ * google.options({auth: authClient});
2931
+ *
2932
+ * // Do the magic
2933
+ * const res =
2934
+ * await toolresults.projects.histories.executions.steps.accessibilityClusters(
2935
+ * {
2936
+ * // The accepted format is the canonical Unicode format with hyphen as a delimiter. Language must be lowercase, Language Script - Capitalized, Region - UPPERCASE. See http://www.unicode.org/reports/tr35/#Unicode_locale_identifier for details. Required.
2937
+ * locale: 'placeholder-value',
2938
+ * // A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.
2939
+ * name: 'projects/my-project/histories/my-historie/executions/my-execution/steps/my-step',
2940
+ * },
2941
+ * );
2942
+ * console.log(res.data);
2943
+ *
2944
+ * // Example response
2945
+ * // {
2946
+ * // "clusters": [],
2947
+ * // "name": "my_name"
2948
+ * // }
2949
+ * }
2950
+ *
2951
+ * main().catch(e => {
2952
+ * console.error(e);
2953
+ * throw e;
2954
+ * });
2955
+ *
2956
+ * ```
2163
2957
  *
2164
2958
  * @param params - Parameters for request
2165
2959
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2174,6 +2968,94 @@ export declare namespace toolresults_v1beta3 {
2174
2968
  accessibilityClusters(callback: BodyResponseCallback<Schema$ListStepAccessibilityClustersResponse>): void;
2175
2969
  /**
2176
2970
  * 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
2971
+ * @example
2972
+ * ```js
2973
+ * // Before running the sample:
2974
+ * // - Enable the API at:
2975
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2976
+ * // - Login into gcloud by running:
2977
+ * // ```sh
2978
+ * // $ gcloud auth application-default login
2979
+ * // ```
2980
+ * // - Install the npm module by running:
2981
+ * // ```sh
2982
+ * // $ npm install googleapis
2983
+ * // ```
2984
+ *
2985
+ * const {google} = require('googleapis');
2986
+ * const toolresults = google.toolresults('v1beta3');
2987
+ *
2988
+ * async function main() {
2989
+ * const auth = new google.auth.GoogleAuth({
2990
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2991
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2992
+ * });
2993
+ *
2994
+ * // Acquire an auth client, and bind it to all future calls
2995
+ * const authClient = await auth.getClient();
2996
+ * google.options({auth: authClient});
2997
+ *
2998
+ * // Do the magic
2999
+ * const res = await toolresults.projects.histories.executions.steps.create({
3000
+ * // Required. An Execution id.
3001
+ * executionId: 'placeholder-value',
3002
+ * // Required. A History id.
3003
+ * historyId: 'placeholder-value',
3004
+ * // Required. A Project id.
3005
+ * projectId: 'placeholder-value',
3006
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
3007
+ * requestId: 'placeholder-value',
3008
+ *
3009
+ * // Request body metadata
3010
+ * requestBody: {
3011
+ * // request body parameters
3012
+ * // {
3013
+ * // "completionTime": {},
3014
+ * // "creationTime": {},
3015
+ * // "description": "my_description",
3016
+ * // "deviceUsageDuration": {},
3017
+ * // "dimensionValue": [],
3018
+ * // "hasImages": false,
3019
+ * // "labels": [],
3020
+ * // "multiStep": {},
3021
+ * // "name": "my_name",
3022
+ * // "outcome": {},
3023
+ * // "runDuration": {},
3024
+ * // "state": "my_state",
3025
+ * // "stepId": "my_stepId",
3026
+ * // "testExecutionStep": {},
3027
+ * // "toolExecutionStep": {}
3028
+ * // }
3029
+ * },
3030
+ * });
3031
+ * console.log(res.data);
3032
+ *
3033
+ * // Example response
3034
+ * // {
3035
+ * // "completionTime": {},
3036
+ * // "creationTime": {},
3037
+ * // "description": "my_description",
3038
+ * // "deviceUsageDuration": {},
3039
+ * // "dimensionValue": [],
3040
+ * // "hasImages": false,
3041
+ * // "labels": [],
3042
+ * // "multiStep": {},
3043
+ * // "name": "my_name",
3044
+ * // "outcome": {},
3045
+ * // "runDuration": {},
3046
+ * // "state": "my_state",
3047
+ * // "stepId": "my_stepId",
3048
+ * // "testExecutionStep": {},
3049
+ * // "toolExecutionStep": {}
3050
+ * // }
3051
+ * }
3052
+ *
3053
+ * main().catch(e => {
3054
+ * console.error(e);
3055
+ * throw e;
3056
+ * });
3057
+ *
3058
+ * ```
2177
3059
  *
2178
3060
  * @param params - Parameters for request
2179
3061
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2188,6 +3070,72 @@ export declare namespace toolresults_v1beta3 {
2188
3070
  create(callback: BodyResponseCallback<Schema$Step>): void;
2189
3071
  /**
2190
3072
  * 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
3073
+ * @example
3074
+ * ```js
3075
+ * // Before running the sample:
3076
+ * // - Enable the API at:
3077
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3078
+ * // - Login into gcloud by running:
3079
+ * // ```sh
3080
+ * // $ gcloud auth application-default login
3081
+ * // ```
3082
+ * // - Install the npm module by running:
3083
+ * // ```sh
3084
+ * // $ npm install googleapis
3085
+ * // ```
3086
+ *
3087
+ * const {google} = require('googleapis');
3088
+ * const toolresults = google.toolresults('v1beta3');
3089
+ *
3090
+ * async function main() {
3091
+ * const auth = new google.auth.GoogleAuth({
3092
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3093
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3094
+ * });
3095
+ *
3096
+ * // Acquire an auth client, and bind it to all future calls
3097
+ * const authClient = await auth.getClient();
3098
+ * google.options({auth: authClient});
3099
+ *
3100
+ * // Do the magic
3101
+ * const res = await toolresults.projects.histories.executions.steps.get({
3102
+ * // A Execution id. Required.
3103
+ * executionId: 'placeholder-value',
3104
+ * // A History id. Required.
3105
+ * historyId: 'placeholder-value',
3106
+ * // A Project id. Required.
3107
+ * projectId: 'placeholder-value',
3108
+ * // A Step id. Required.
3109
+ * stepId: 'placeholder-value',
3110
+ * });
3111
+ * console.log(res.data);
3112
+ *
3113
+ * // Example response
3114
+ * // {
3115
+ * // "completionTime": {},
3116
+ * // "creationTime": {},
3117
+ * // "description": "my_description",
3118
+ * // "deviceUsageDuration": {},
3119
+ * // "dimensionValue": [],
3120
+ * // "hasImages": false,
3121
+ * // "labels": [],
3122
+ * // "multiStep": {},
3123
+ * // "name": "my_name",
3124
+ * // "outcome": {},
3125
+ * // "runDuration": {},
3126
+ * // "state": "my_state",
3127
+ * // "stepId": "my_stepId",
3128
+ * // "testExecutionStep": {},
3129
+ * // "toolExecutionStep": {}
3130
+ * // }
3131
+ * }
3132
+ *
3133
+ * main().catch(e => {
3134
+ * console.error(e);
3135
+ * throw e;
3136
+ * });
3137
+ *
3138
+ * ```
2191
3139
  *
2192
3140
  * @param params - Parameters for request
2193
3141
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2202,6 +3150,68 @@ export declare namespace toolresults_v1beta3 {
2202
3150
  get(callback: BodyResponseCallback<Schema$Step>): void;
2203
3151
  /**
2204
3152
  * Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist
3153
+ * @example
3154
+ * ```js
3155
+ * // Before running the sample:
3156
+ * // - Enable the API at:
3157
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3158
+ * // - Login into gcloud by running:
3159
+ * // ```sh
3160
+ * // $ gcloud auth application-default login
3161
+ * // ```
3162
+ * // - Install the npm module by running:
3163
+ * // ```sh
3164
+ * // $ npm install googleapis
3165
+ * // ```
3166
+ *
3167
+ * const {google} = require('googleapis');
3168
+ * const toolresults = google.toolresults('v1beta3');
3169
+ *
3170
+ * async function main() {
3171
+ * const auth = new google.auth.GoogleAuth({
3172
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3173
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3174
+ * });
3175
+ *
3176
+ * // Acquire an auth client, and bind it to all future calls
3177
+ * const authClient = await auth.getClient();
3178
+ * google.options({auth: authClient});
3179
+ *
3180
+ * // Do the magic
3181
+ * const res =
3182
+ * await toolresults.projects.histories.executions.steps.getPerfMetricsSummary(
3183
+ * {
3184
+ * // A tool results execution ID.
3185
+ * executionId: 'placeholder-value',
3186
+ * // A tool results history ID.
3187
+ * historyId: 'placeholder-value',
3188
+ * // The cloud project
3189
+ * projectId: 'placeholder-value',
3190
+ * // A tool results step ID.
3191
+ * stepId: 'placeholder-value',
3192
+ * },
3193
+ * );
3194
+ * console.log(res.data);
3195
+ *
3196
+ * // Example response
3197
+ * // {
3198
+ * // "appStartTime": {},
3199
+ * // "executionId": "my_executionId",
3200
+ * // "graphicsStats": {},
3201
+ * // "historyId": "my_historyId",
3202
+ * // "perfEnvironment": {},
3203
+ * // "perfMetrics": [],
3204
+ * // "projectId": "my_projectId",
3205
+ * // "stepId": "my_stepId"
3206
+ * // }
3207
+ * }
3208
+ *
3209
+ * main().catch(e => {
3210
+ * console.error(e);
3211
+ * throw e;
3212
+ * });
3213
+ *
3214
+ * ```
2205
3215
  *
2206
3216
  * @param params - Parameters for request
2207
3217
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2216,6 +3226,61 @@ export declare namespace toolresults_v1beta3 {
2216
3226
  getPerfMetricsSummary(callback: BodyResponseCallback<Schema$PerfMetricsSummary>): void;
2217
3227
  /**
2218
3228
  * 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
3229
+ * @example
3230
+ * ```js
3231
+ * // Before running the sample:
3232
+ * // - Enable the API at:
3233
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3234
+ * // - Login into gcloud by running:
3235
+ * // ```sh
3236
+ * // $ gcloud auth application-default login
3237
+ * // ```
3238
+ * // - Install the npm module by running:
3239
+ * // ```sh
3240
+ * // $ npm install googleapis
3241
+ * // ```
3242
+ *
3243
+ * const {google} = require('googleapis');
3244
+ * const toolresults = google.toolresults('v1beta3');
3245
+ *
3246
+ * async function main() {
3247
+ * const auth = new google.auth.GoogleAuth({
3248
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3249
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3250
+ * });
3251
+ *
3252
+ * // Acquire an auth client, and bind it to all future calls
3253
+ * const authClient = await auth.getClient();
3254
+ * google.options({auth: authClient});
3255
+ *
3256
+ * // Do the magic
3257
+ * const res = await toolresults.projects.histories.executions.steps.list({
3258
+ * // A Execution id. Required.
3259
+ * executionId: 'placeholder-value',
3260
+ * // A History id. Required.
3261
+ * historyId: 'placeholder-value',
3262
+ * // 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.
3263
+ * pageSize: 'placeholder-value',
3264
+ * // A continuation token to resume the query at the next item. Optional.
3265
+ * pageToken: 'placeholder-value',
3266
+ * // A Project id. Required.
3267
+ * projectId: 'placeholder-value',
3268
+ * });
3269
+ * console.log(res.data);
3270
+ *
3271
+ * // Example response
3272
+ * // {
3273
+ * // "nextPageToken": "my_nextPageToken",
3274
+ * // "steps": []
3275
+ * // }
3276
+ * }
3277
+ *
3278
+ * main().catch(e => {
3279
+ * console.error(e);
3280
+ * throw e;
3281
+ * });
3282
+ *
3283
+ * ```
2219
3284
  *
2220
3285
  * @param params - Parameters for request
2221
3286
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2230,6 +3295,96 @@ export declare namespace toolresults_v1beta3 {
2230
3295
  list(callback: BodyResponseCallback<Schema$ListStepsResponse>): void;
2231
3296
  /**
2232
3297
  * 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
3298
+ * @example
3299
+ * ```js
3300
+ * // Before running the sample:
3301
+ * // - Enable the API at:
3302
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3303
+ * // - Login into gcloud by running:
3304
+ * // ```sh
3305
+ * // $ gcloud auth application-default login
3306
+ * // ```
3307
+ * // - Install the npm module by running:
3308
+ * // ```sh
3309
+ * // $ npm install googleapis
3310
+ * // ```
3311
+ *
3312
+ * const {google} = require('googleapis');
3313
+ * const toolresults = google.toolresults('v1beta3');
3314
+ *
3315
+ * async function main() {
3316
+ * const auth = new google.auth.GoogleAuth({
3317
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3318
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3319
+ * });
3320
+ *
3321
+ * // Acquire an auth client, and bind it to all future calls
3322
+ * const authClient = await auth.getClient();
3323
+ * google.options({auth: authClient});
3324
+ *
3325
+ * // Do the magic
3326
+ * const res = await toolresults.projects.histories.executions.steps.patch({
3327
+ * // A Execution id. Required.
3328
+ * executionId: 'placeholder-value',
3329
+ * // A History id. Required.
3330
+ * historyId: 'placeholder-value',
3331
+ * // A Project id. Required.
3332
+ * projectId: 'placeholder-value',
3333
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
3334
+ * requestId: 'placeholder-value',
3335
+ * // A Step id. Required.
3336
+ * stepId: 'placeholder-value',
3337
+ *
3338
+ * // Request body metadata
3339
+ * requestBody: {
3340
+ * // request body parameters
3341
+ * // {
3342
+ * // "completionTime": {},
3343
+ * // "creationTime": {},
3344
+ * // "description": "my_description",
3345
+ * // "deviceUsageDuration": {},
3346
+ * // "dimensionValue": [],
3347
+ * // "hasImages": false,
3348
+ * // "labels": [],
3349
+ * // "multiStep": {},
3350
+ * // "name": "my_name",
3351
+ * // "outcome": {},
3352
+ * // "runDuration": {},
3353
+ * // "state": "my_state",
3354
+ * // "stepId": "my_stepId",
3355
+ * // "testExecutionStep": {},
3356
+ * // "toolExecutionStep": {}
3357
+ * // }
3358
+ * },
3359
+ * });
3360
+ * console.log(res.data);
3361
+ *
3362
+ * // Example response
3363
+ * // {
3364
+ * // "completionTime": {},
3365
+ * // "creationTime": {},
3366
+ * // "description": "my_description",
3367
+ * // "deviceUsageDuration": {},
3368
+ * // "dimensionValue": [],
3369
+ * // "hasImages": false,
3370
+ * // "labels": [],
3371
+ * // "multiStep": {},
3372
+ * // "name": "my_name",
3373
+ * // "outcome": {},
3374
+ * // "runDuration": {},
3375
+ * // "state": "my_state",
3376
+ * // "stepId": "my_stepId",
3377
+ * // "testExecutionStep": {},
3378
+ * // "toolExecutionStep": {}
3379
+ * // }
3380
+ * }
3381
+ *
3382
+ * main().catch(e => {
3383
+ * console.error(e);
3384
+ * throw e;
3385
+ * });
3386
+ *
3387
+ * ```
2233
3388
  *
2234
3389
  * @param params - Parameters for request
2235
3390
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2244,6 +3399,81 @@ export declare namespace toolresults_v1beta3 {
2244
3399
  patch(callback: BodyResponseCallback<Schema$Step>): void;
2245
3400
  /**
2246
3401
  * 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
3402
+ * @example
3403
+ * ```js
3404
+ * // Before running the sample:
3405
+ * // - Enable the API at:
3406
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3407
+ * // - Login into gcloud by running:
3408
+ * // ```sh
3409
+ * // $ gcloud auth application-default login
3410
+ * // ```
3411
+ * // - Install the npm module by running:
3412
+ * // ```sh
3413
+ * // $ npm install googleapis
3414
+ * // ```
3415
+ *
3416
+ * const {google} = require('googleapis');
3417
+ * const toolresults = google.toolresults('v1beta3');
3418
+ *
3419
+ * async function main() {
3420
+ * const auth = new google.auth.GoogleAuth({
3421
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3422
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3423
+ * });
3424
+ *
3425
+ * // Acquire an auth client, and bind it to all future calls
3426
+ * const authClient = await auth.getClient();
3427
+ * google.options({auth: authClient});
3428
+ *
3429
+ * // Do the magic
3430
+ * const res =
3431
+ * await toolresults.projects.histories.executions.steps.publishXunitXmlFiles({
3432
+ * // A Execution id. Required.
3433
+ * executionId: 'placeholder-value',
3434
+ * // A History id. Required.
3435
+ * historyId: 'placeholder-value',
3436
+ * // A Project id. Required.
3437
+ * projectId: 'placeholder-value',
3438
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
3439
+ * stepId: 'placeholder-value',
3440
+ *
3441
+ * // Request body metadata
3442
+ * requestBody: {
3443
+ * // request body parameters
3444
+ * // {
3445
+ * // "xunitXmlFiles": []
3446
+ * // }
3447
+ * },
3448
+ * });
3449
+ * console.log(res.data);
3450
+ *
3451
+ * // Example response
3452
+ * // {
3453
+ * // "completionTime": {},
3454
+ * // "creationTime": {},
3455
+ * // "description": "my_description",
3456
+ * // "deviceUsageDuration": {},
3457
+ * // "dimensionValue": [],
3458
+ * // "hasImages": false,
3459
+ * // "labels": [],
3460
+ * // "multiStep": {},
3461
+ * // "name": "my_name",
3462
+ * // "outcome": {},
3463
+ * // "runDuration": {},
3464
+ * // "state": "my_state",
3465
+ * // "stepId": "my_stepId",
3466
+ * // "testExecutionStep": {},
3467
+ * // "toolExecutionStep": {}
3468
+ * // }
3469
+ * }
3470
+ *
3471
+ * main().catch(e => {
3472
+ * console.error(e);
3473
+ * throw e;
3474
+ * });
3475
+ *
3476
+ * ```
2247
3477
  *
2248
3478
  * @param params - Parameters for request
2249
3479
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2400,6 +3630,83 @@ export declare namespace toolresults_v1beta3 {
2400
3630
  constructor(context: APIRequestContext);
2401
3631
  /**
2402
3632
  * 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
3633
+ * @example
3634
+ * ```js
3635
+ * // Before running the sample:
3636
+ * // - Enable the API at:
3637
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3638
+ * // - Login into gcloud by running:
3639
+ * // ```sh
3640
+ * // $ gcloud auth application-default login
3641
+ * // ```
3642
+ * // - Install the npm module by running:
3643
+ * // ```sh
3644
+ * // $ npm install googleapis
3645
+ * // ```
3646
+ *
3647
+ * const {google} = require('googleapis');
3648
+ * const toolresults = google.toolresults('v1beta3');
3649
+ *
3650
+ * async function main() {
3651
+ * const auth = new google.auth.GoogleAuth({
3652
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3653
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3654
+ * });
3655
+ *
3656
+ * // Acquire an auth client, and bind it to all future calls
3657
+ * const authClient = await auth.getClient();
3658
+ * google.options({auth: authClient});
3659
+ *
3660
+ * // Do the magic
3661
+ * const res =
3662
+ * await toolresults.projects.histories.executions.steps.perfMetricsSummary.create(
3663
+ * {
3664
+ * // A tool results execution ID.
3665
+ * executionId: 'placeholder-value',
3666
+ * // A tool results history ID.
3667
+ * historyId: 'placeholder-value',
3668
+ * // The cloud project
3669
+ * projectId: 'placeholder-value',
3670
+ * // A tool results step ID.
3671
+ * stepId: 'placeholder-value',
3672
+ *
3673
+ * // Request body metadata
3674
+ * requestBody: {
3675
+ * // request body parameters
3676
+ * // {
3677
+ * // "appStartTime": {},
3678
+ * // "executionId": "my_executionId",
3679
+ * // "graphicsStats": {},
3680
+ * // "historyId": "my_historyId",
3681
+ * // "perfEnvironment": {},
3682
+ * // "perfMetrics": [],
3683
+ * // "projectId": "my_projectId",
3684
+ * // "stepId": "my_stepId"
3685
+ * // }
3686
+ * },
3687
+ * },
3688
+ * );
3689
+ * console.log(res.data);
3690
+ *
3691
+ * // Example response
3692
+ * // {
3693
+ * // "appStartTime": {},
3694
+ * // "executionId": "my_executionId",
3695
+ * // "graphicsStats": {},
3696
+ * // "historyId": "my_historyId",
3697
+ * // "perfEnvironment": {},
3698
+ * // "perfMetrics": [],
3699
+ * // "projectId": "my_projectId",
3700
+ * // "stepId": "my_stepId"
3701
+ * // }
3702
+ * }
3703
+ *
3704
+ * main().catch(e => {
3705
+ * console.error(e);
3706
+ * throw e;
3707
+ * });
3708
+ *
3709
+ * ```
2403
3710
  *
2404
3711
  * @param params - Parameters for request
2405
3712
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2441,6 +3748,79 @@ export declare namespace toolresults_v1beta3 {
2441
3748
  constructor(context: APIRequestContext);
2442
3749
  /**
2443
3750
  * 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
3751
+ * @example
3752
+ * ```js
3753
+ * // Before running the sample:
3754
+ * // - Enable the API at:
3755
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3756
+ * // - Login into gcloud by running:
3757
+ * // ```sh
3758
+ * // $ gcloud auth application-default login
3759
+ * // ```
3760
+ * // - Install the npm module by running:
3761
+ * // ```sh
3762
+ * // $ npm install googleapis
3763
+ * // ```
3764
+ *
3765
+ * const {google} = require('googleapis');
3766
+ * const toolresults = google.toolresults('v1beta3');
3767
+ *
3768
+ * async function main() {
3769
+ * const auth = new google.auth.GoogleAuth({
3770
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3771
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3772
+ * });
3773
+ *
3774
+ * // Acquire an auth client, and bind it to all future calls
3775
+ * const authClient = await auth.getClient();
3776
+ * google.options({auth: authClient});
3777
+ *
3778
+ * // Do the magic
3779
+ * const res =
3780
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.create(
3781
+ * {
3782
+ * // A tool results execution ID.
3783
+ * executionId: 'placeholder-value',
3784
+ * // A tool results history ID.
3785
+ * historyId: 'placeholder-value',
3786
+ * // The cloud project
3787
+ * projectId: 'placeholder-value',
3788
+ * // A tool results step ID.
3789
+ * stepId: 'placeholder-value',
3790
+ *
3791
+ * // Request body metadata
3792
+ * requestBody: {
3793
+ * // request body parameters
3794
+ * // {
3795
+ * // "basicPerfSampleSeries": {},
3796
+ * // "executionId": "my_executionId",
3797
+ * // "historyId": "my_historyId",
3798
+ * // "projectId": "my_projectId",
3799
+ * // "sampleSeriesId": "my_sampleSeriesId",
3800
+ * // "stepId": "my_stepId"
3801
+ * // }
3802
+ * },
3803
+ * },
3804
+ * );
3805
+ * console.log(res.data);
3806
+ *
3807
+ * // Example response
3808
+ * // {
3809
+ * // "basicPerfSampleSeries": {},
3810
+ * // "executionId": "my_executionId",
3811
+ * // "historyId": "my_historyId",
3812
+ * // "projectId": "my_projectId",
3813
+ * // "sampleSeriesId": "my_sampleSeriesId",
3814
+ * // "stepId": "my_stepId"
3815
+ * // }
3816
+ * }
3817
+ *
3818
+ * main().catch(e => {
3819
+ * console.error(e);
3820
+ * throw e;
3821
+ * });
3822
+ *
3823
+ * ```
2444
3824
  *
2445
3825
  * @param params - Parameters for request
2446
3826
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2455,6 +3835,66 @@ export declare namespace toolresults_v1beta3 {
2455
3835
  create(callback: BodyResponseCallback<Schema$PerfSampleSeries>): void;
2456
3836
  /**
2457
3837
  * Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
3838
+ * @example
3839
+ * ```js
3840
+ * // Before running the sample:
3841
+ * // - Enable the API at:
3842
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3843
+ * // - Login into gcloud by running:
3844
+ * // ```sh
3845
+ * // $ gcloud auth application-default login
3846
+ * // ```
3847
+ * // - Install the npm module by running:
3848
+ * // ```sh
3849
+ * // $ npm install googleapis
3850
+ * // ```
3851
+ *
3852
+ * const {google} = require('googleapis');
3853
+ * const toolresults = google.toolresults('v1beta3');
3854
+ *
3855
+ * async function main() {
3856
+ * const auth = new google.auth.GoogleAuth({
3857
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3858
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3859
+ * });
3860
+ *
3861
+ * // Acquire an auth client, and bind it to all future calls
3862
+ * const authClient = await auth.getClient();
3863
+ * google.options({auth: authClient});
3864
+ *
3865
+ * // Do the magic
3866
+ * const res =
3867
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.get({
3868
+ * // A tool results execution ID.
3869
+ * executionId: 'placeholder-value',
3870
+ * // A tool results history ID.
3871
+ * historyId: 'placeholder-value',
3872
+ * // The cloud project
3873
+ * projectId: 'placeholder-value',
3874
+ * // A sample series id
3875
+ * sampleSeriesId: 'placeholder-value',
3876
+ * // A tool results step ID.
3877
+ * stepId: 'placeholder-value',
3878
+ * });
3879
+ * console.log(res.data);
3880
+ *
3881
+ * // Example response
3882
+ * // {
3883
+ * // "basicPerfSampleSeries": {},
3884
+ * // "executionId": "my_executionId",
3885
+ * // "historyId": "my_historyId",
3886
+ * // "projectId": "my_projectId",
3887
+ * // "sampleSeriesId": "my_sampleSeriesId",
3888
+ * // "stepId": "my_stepId"
3889
+ * // }
3890
+ * }
3891
+ *
3892
+ * main().catch(e => {
3893
+ * console.error(e);
3894
+ * throw e;
3895
+ * });
3896
+ *
3897
+ * ```
2458
3898
  *
2459
3899
  * @param params - Parameters for request
2460
3900
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2469,6 +3909,63 @@ export declare namespace toolresults_v1beta3 {
2469
3909
  get(callback: BodyResponseCallback<Schema$PerfSampleSeries>): void;
2470
3910
  /**
2471
3911
  * 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
3912
+ * @example
3913
+ * ```js
3914
+ * // Before running the sample:
3915
+ * // - Enable the API at:
3916
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3917
+ * // - Login into gcloud by running:
3918
+ * // ```sh
3919
+ * // $ gcloud auth application-default login
3920
+ * // ```
3921
+ * // - Install the npm module by running:
3922
+ * // ```sh
3923
+ * // $ npm install googleapis
3924
+ * // ```
3925
+ *
3926
+ * const {google} = require('googleapis');
3927
+ * const toolresults = google.toolresults('v1beta3');
3928
+ *
3929
+ * async function main() {
3930
+ * const auth = new google.auth.GoogleAuth({
3931
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3932
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3933
+ * });
3934
+ *
3935
+ * // Acquire an auth client, and bind it to all future calls
3936
+ * const authClient = await auth.getClient();
3937
+ * google.options({auth: authClient});
3938
+ *
3939
+ * // Do the magic
3940
+ * const res =
3941
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.list(
3942
+ * {
3943
+ * // A tool results execution ID.
3944
+ * executionId: 'placeholder-value',
3945
+ * // Specify one or more PerfMetricType values such as CPU to filter the result
3946
+ * filter: 'placeholder-value',
3947
+ * // A tool results history ID.
3948
+ * historyId: 'placeholder-value',
3949
+ * // The cloud project
3950
+ * projectId: 'placeholder-value',
3951
+ * // A tool results step ID.
3952
+ * stepId: 'placeholder-value',
3953
+ * },
3954
+ * );
3955
+ * console.log(res.data);
3956
+ *
3957
+ * // Example response
3958
+ * // {
3959
+ * // "perfSampleSeries": []
3960
+ * // }
3961
+ * }
3962
+ *
3963
+ * main().catch(e => {
3964
+ * console.error(e);
3965
+ * throw e;
3966
+ * });
3967
+ *
3968
+ * ```
2472
3969
  *
2473
3970
  * @param params - Parameters for request
2474
3971
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2553,6 +4050,71 @@ export declare namespace toolresults_v1beta3 {
2553
4050
  constructor(context: APIRequestContext);
2554
4051
  /**
2555
4052
  * 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
4053
+ * @example
4054
+ * ```js
4055
+ * // Before running the sample:
4056
+ * // - Enable the API at:
4057
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4058
+ * // - Login into gcloud by running:
4059
+ * // ```sh
4060
+ * // $ gcloud auth application-default login
4061
+ * // ```
4062
+ * // - Install the npm module by running:
4063
+ * // ```sh
4064
+ * // $ npm install googleapis
4065
+ * // ```
4066
+ *
4067
+ * const {google} = require('googleapis');
4068
+ * const toolresults = google.toolresults('v1beta3');
4069
+ *
4070
+ * async function main() {
4071
+ * const auth = new google.auth.GoogleAuth({
4072
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4073
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4074
+ * });
4075
+ *
4076
+ * // Acquire an auth client, and bind it to all future calls
4077
+ * const authClient = await auth.getClient();
4078
+ * google.options({auth: authClient});
4079
+ *
4080
+ * // Do the magic
4081
+ * const res =
4082
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate(
4083
+ * {
4084
+ * // A tool results execution ID.
4085
+ * executionId: 'placeholder-value',
4086
+ * // A tool results history ID.
4087
+ * historyId: 'placeholder-value',
4088
+ * // The cloud project
4089
+ * projectId: 'placeholder-value',
4090
+ * // A sample series id
4091
+ * sampleSeriesId: 'placeholder-value',
4092
+ * // A tool results step ID.
4093
+ * stepId: 'placeholder-value',
4094
+ *
4095
+ * // Request body metadata
4096
+ * requestBody: {
4097
+ * // request body parameters
4098
+ * // {
4099
+ * // "perfSamples": []
4100
+ * // }
4101
+ * },
4102
+ * },
4103
+ * );
4104
+ * console.log(res.data);
4105
+ *
4106
+ * // Example response
4107
+ * // {
4108
+ * // "perfSamples": []
4109
+ * // }
4110
+ * }
4111
+ *
4112
+ * main().catch(e => {
4113
+ * console.error(e);
4114
+ * throw e;
4115
+ * });
4116
+ *
4117
+ * ```
2556
4118
  *
2557
4119
  * @param params - Parameters for request
2558
4120
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2567,6 +4129,68 @@ export declare namespace toolresults_v1beta3 {
2567
4129
  batchCreate(callback: BodyResponseCallback<Schema$BatchCreatePerfSamplesResponse>): void;
2568
4130
  /**
2569
4131
  * 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
4132
+ * @example
4133
+ * ```js
4134
+ * // Before running the sample:
4135
+ * // - Enable the API at:
4136
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4137
+ * // - Login into gcloud by running:
4138
+ * // ```sh
4139
+ * // $ gcloud auth application-default login
4140
+ * // ```
4141
+ * // - Install the npm module by running:
4142
+ * // ```sh
4143
+ * // $ npm install googleapis
4144
+ * // ```
4145
+ *
4146
+ * const {google} = require('googleapis');
4147
+ * const toolresults = google.toolresults('v1beta3');
4148
+ *
4149
+ * async function main() {
4150
+ * const auth = new google.auth.GoogleAuth({
4151
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4152
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4153
+ * });
4154
+ *
4155
+ * // Acquire an auth client, and bind it to all future calls
4156
+ * const authClient = await auth.getClient();
4157
+ * google.options({auth: authClient});
4158
+ *
4159
+ * // Do the magic
4160
+ * const res =
4161
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list(
4162
+ * {
4163
+ * // A tool results execution ID.
4164
+ * executionId: 'placeholder-value',
4165
+ * // A tool results history ID.
4166
+ * historyId: 'placeholder-value',
4167
+ * // 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
4168
+ * pageSize: 'placeholder-value',
4169
+ * // Optional, the next_page_token returned in the previous response
4170
+ * pageToken: 'placeholder-value',
4171
+ * // The cloud project
4172
+ * projectId: 'placeholder-value',
4173
+ * // A sample series id
4174
+ * sampleSeriesId: 'placeholder-value',
4175
+ * // A tool results step ID.
4176
+ * stepId: 'placeholder-value',
4177
+ * },
4178
+ * );
4179
+ * console.log(res.data);
4180
+ *
4181
+ * // Example response
4182
+ * // {
4183
+ * // "nextPageToken": "my_nextPageToken",
4184
+ * // "perfSamples": []
4185
+ * // }
4186
+ * }
4187
+ *
4188
+ * main().catch(e => {
4189
+ * console.error(e);
4190
+ * throw e;
4191
+ * });
4192
+ *
4193
+ * ```
2570
4194
  *
2571
4195
  * @param params - Parameters for request
2572
4196
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2641,6 +4265,69 @@ export declare namespace toolresults_v1beta3 {
2641
4265
  constructor(context: APIRequestContext);
2642
4266
  /**
2643
4267
  * 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
4268
+ * @example
4269
+ * ```js
4270
+ * // Before running the sample:
4271
+ * // - Enable the API at:
4272
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4273
+ * // - Login into gcloud by running:
4274
+ * // ```sh
4275
+ * // $ gcloud auth application-default login
4276
+ * // ```
4277
+ * // - Install the npm module by running:
4278
+ * // ```sh
4279
+ * // $ npm install googleapis
4280
+ * // ```
4281
+ *
4282
+ * const {google} = require('googleapis');
4283
+ * const toolresults = google.toolresults('v1beta3');
4284
+ *
4285
+ * async function main() {
4286
+ * const auth = new google.auth.GoogleAuth({
4287
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4288
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4289
+ * });
4290
+ *
4291
+ * // Acquire an auth client, and bind it to all future calls
4292
+ * const authClient = await auth.getClient();
4293
+ * google.options({auth: authClient});
4294
+ *
4295
+ * // Do the magic
4296
+ * const res =
4297
+ * await toolresults.projects.histories.executions.steps.testCases.get({
4298
+ * // A Execution id Required.
4299
+ * executionId: 'placeholder-value',
4300
+ * // A History id. Required.
4301
+ * historyId: 'placeholder-value',
4302
+ * // A Project id. Required.
4303
+ * projectId: 'placeholder-value',
4304
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
4305
+ * stepId: 'placeholder-value',
4306
+ * // A Test Case id. Required.
4307
+ * testCaseId: 'placeholder-value',
4308
+ * });
4309
+ * console.log(res.data);
4310
+ *
4311
+ * // Example response
4312
+ * // {
4313
+ * // "elapsedTime": {},
4314
+ * // "endTime": {},
4315
+ * // "skippedMessage": "my_skippedMessage",
4316
+ * // "stackTraces": [],
4317
+ * // "startTime": {},
4318
+ * // "status": "my_status",
4319
+ * // "testCaseId": "my_testCaseId",
4320
+ * // "testCaseReference": {},
4321
+ * // "toolOutputs": []
4322
+ * // }
4323
+ * }
4324
+ *
4325
+ * main().catch(e => {
4326
+ * console.error(e);
4327
+ * throw e;
4328
+ * });
4329
+ *
4330
+ * ```
2644
4331
  *
2645
4332
  * @param params - Parameters for request
2646
4333
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2655,6 +4342,64 @@ export declare namespace toolresults_v1beta3 {
2655
4342
  get(callback: BodyResponseCallback<Schema$TestCase>): void;
2656
4343
  /**
2657
4344
  * 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
4345
+ * @example
4346
+ * ```js
4347
+ * // Before running the sample:
4348
+ * // - Enable the API at:
4349
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4350
+ * // - Login into gcloud by running:
4351
+ * // ```sh
4352
+ * // $ gcloud auth application-default login
4353
+ * // ```
4354
+ * // - Install the npm module by running:
4355
+ * // ```sh
4356
+ * // $ npm install googleapis
4357
+ * // ```
4358
+ *
4359
+ * const {google} = require('googleapis');
4360
+ * const toolresults = google.toolresults('v1beta3');
4361
+ *
4362
+ * async function main() {
4363
+ * const auth = new google.auth.GoogleAuth({
4364
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4365
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4366
+ * });
4367
+ *
4368
+ * // Acquire an auth client, and bind it to all future calls
4369
+ * const authClient = await auth.getClient();
4370
+ * google.options({auth: authClient});
4371
+ *
4372
+ * // Do the magic
4373
+ * const res =
4374
+ * await toolresults.projects.histories.executions.steps.testCases.list({
4375
+ * // A Execution id Required.
4376
+ * executionId: 'placeholder-value',
4377
+ * // A History id. Required.
4378
+ * historyId: 'placeholder-value',
4379
+ * // The maximum number of TestCases to fetch. Default value: 100. The server will use this default if the field is not set or has a value of 0. Optional.
4380
+ * pageSize: 'placeholder-value',
4381
+ * // A continuation token to resume the query at the next item. Optional.
4382
+ * pageToken: 'placeholder-value',
4383
+ * // A Project id. Required.
4384
+ * projectId: 'placeholder-value',
4385
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
4386
+ * stepId: 'placeholder-value',
4387
+ * });
4388
+ * console.log(res.data);
4389
+ *
4390
+ * // Example response
4391
+ * // {
4392
+ * // "nextPageToken": "my_nextPageToken",
4393
+ * // "testCases": []
4394
+ * // }
4395
+ * }
4396
+ *
4397
+ * main().catch(e => {
4398
+ * console.error(e);
4399
+ * throw e;
4400
+ * });
4401
+ *
4402
+ * ```
2658
4403
  *
2659
4404
  * @param params - Parameters for request
2660
4405
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2721,6 +4466,64 @@ export declare namespace toolresults_v1beta3 {
2721
4466
  constructor(context: APIRequestContext);
2722
4467
  /**
2723
4468
  * 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
4469
+ * @example
4470
+ * ```js
4471
+ * // Before running the sample:
4472
+ * // - Enable the API at:
4473
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4474
+ * // - Login into gcloud by running:
4475
+ * // ```sh
4476
+ * // $ gcloud auth application-default login
4477
+ * // ```
4478
+ * // - Install the npm module by running:
4479
+ * // ```sh
4480
+ * // $ npm install googleapis
4481
+ * // ```
4482
+ *
4483
+ * const {google} = require('googleapis');
4484
+ * const toolresults = google.toolresults('v1beta3');
4485
+ *
4486
+ * async function main() {
4487
+ * const auth = new google.auth.GoogleAuth({
4488
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4489
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4490
+ * });
4491
+ *
4492
+ * // Acquire an auth client, and bind it to all future calls
4493
+ * const authClient = await auth.getClient();
4494
+ * google.options({auth: authClient});
4495
+ *
4496
+ * // Do the magic
4497
+ * const res =
4498
+ * await toolresults.projects.histories.executions.steps.thumbnails.list({
4499
+ * // An Execution id. Required.
4500
+ * executionId: 'placeholder-value',
4501
+ * // A History id. Required.
4502
+ * historyId: 'placeholder-value',
4503
+ * // 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.
4504
+ * pageSize: 'placeholder-value',
4505
+ * // A continuation token to resume the query at the next item. Optional.
4506
+ * pageToken: 'placeholder-value',
4507
+ * // A Project id. Required.
4508
+ * projectId: 'placeholder-value',
4509
+ * // A Step id. Required.
4510
+ * stepId: 'placeholder-value',
4511
+ * });
4512
+ * console.log(res.data);
4513
+ *
4514
+ * // Example response
4515
+ * // {
4516
+ * // "nextPageToken": "my_nextPageToken",
4517
+ * // "thumbnails": []
4518
+ * // }
4519
+ * }
4520
+ *
4521
+ * main().catch(e => {
4522
+ * console.error(e);
4523
+ * throw e;
4524
+ * });
4525
+ *
4526
+ * ```
2724
4527
  *
2725
4528
  * @param params - Parameters for request
2726
4529
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.