@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.
package/v1beta3.ts CHANGED
@@ -1794,6 +1794,53 @@ export namespace toolresults_v1beta3 {
1794
1794
 
1795
1795
  /**
1796
1796
  * 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
1797
+ * @example
1798
+ * ```js
1799
+ * // Before running the sample:
1800
+ * // - Enable the API at:
1801
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1802
+ * // - Login into gcloud by running:
1803
+ * // ```sh
1804
+ * // $ gcloud auth application-default login
1805
+ * // ```
1806
+ * // - Install the npm module by running:
1807
+ * // ```sh
1808
+ * // $ npm install googleapis
1809
+ * // ```
1810
+ *
1811
+ * const {google} = require('googleapis');
1812
+ * const toolresults = google.toolresults('v1beta3');
1813
+ *
1814
+ * async function main() {
1815
+ * const auth = new google.auth.GoogleAuth({
1816
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1817
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1818
+ * });
1819
+ *
1820
+ * // Acquire an auth client, and bind it to all future calls
1821
+ * const authClient = await auth.getClient();
1822
+ * google.options({auth: authClient});
1823
+ *
1824
+ * // Do the magic
1825
+ * const res = await toolresults.projects.getSettings({
1826
+ * // A Project id. Required.
1827
+ * projectId: 'placeholder-value',
1828
+ * });
1829
+ * console.log(res.data);
1830
+ *
1831
+ * // Example response
1832
+ * // {
1833
+ * // "defaultBucket": "my_defaultBucket",
1834
+ * // "name": "my_name"
1835
+ * // }
1836
+ * }
1837
+ *
1838
+ * main().catch(e => {
1839
+ * console.error(e);
1840
+ * throw e;
1841
+ * });
1842
+ *
1843
+ * ```
1797
1844
  *
1798
1845
  * @param params - Parameters for request
1799
1846
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1884,6 +1931,53 @@ export namespace toolresults_v1beta3 {
1884
1931
 
1885
1932
  /**
1886
1933
  * 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
1934
+ * @example
1935
+ * ```js
1936
+ * // Before running the sample:
1937
+ * // - Enable the API at:
1938
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
1939
+ * // - Login into gcloud by running:
1940
+ * // ```sh
1941
+ * // $ gcloud auth application-default login
1942
+ * // ```
1943
+ * // - Install the npm module by running:
1944
+ * // ```sh
1945
+ * // $ npm install googleapis
1946
+ * // ```
1947
+ *
1948
+ * const {google} = require('googleapis');
1949
+ * const toolresults = google.toolresults('v1beta3');
1950
+ *
1951
+ * async function main() {
1952
+ * const auth = new google.auth.GoogleAuth({
1953
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
1954
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
1955
+ * });
1956
+ *
1957
+ * // Acquire an auth client, and bind it to all future calls
1958
+ * const authClient = await auth.getClient();
1959
+ * google.options({auth: authClient});
1960
+ *
1961
+ * // Do the magic
1962
+ * const res = await toolresults.projects.initializeSettings({
1963
+ * // A Project id. Required.
1964
+ * projectId: 'placeholder-value',
1965
+ * });
1966
+ * console.log(res.data);
1967
+ *
1968
+ * // Example response
1969
+ * // {
1970
+ * // "defaultBucket": "my_defaultBucket",
1971
+ * // "name": "my_name"
1972
+ * // }
1973
+ * }
1974
+ *
1975
+ * main().catch(e => {
1976
+ * console.error(e);
1977
+ * throw e;
1978
+ * });
1979
+ *
1980
+ * ```
1887
1981
  *
1888
1982
  * @param params - Parameters for request
1889
1983
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2003,6 +2097,68 @@ export namespace toolresults_v1beta3 {
2003
2097
 
2004
2098
  /**
2005
2099
  * 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
2100
+ * @example
2101
+ * ```js
2102
+ * // Before running the sample:
2103
+ * // - Enable the API at:
2104
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2105
+ * // - Login into gcloud by running:
2106
+ * // ```sh
2107
+ * // $ gcloud auth application-default login
2108
+ * // ```
2109
+ * // - Install the npm module by running:
2110
+ * // ```sh
2111
+ * // $ npm install googleapis
2112
+ * // ```
2113
+ *
2114
+ * const {google} = require('googleapis');
2115
+ * const toolresults = google.toolresults('v1beta3');
2116
+ *
2117
+ * async function main() {
2118
+ * const auth = new google.auth.GoogleAuth({
2119
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2120
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2121
+ * });
2122
+ *
2123
+ * // Acquire an auth client, and bind it to all future calls
2124
+ * const authClient = await auth.getClient();
2125
+ * google.options({auth: authClient});
2126
+ *
2127
+ * // Do the magic
2128
+ * const res = await toolresults.projects.histories.create({
2129
+ * // A Project id. Required.
2130
+ * projectId: 'placeholder-value',
2131
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
2132
+ * requestId: 'placeholder-value',
2133
+ *
2134
+ * // Request body metadata
2135
+ * requestBody: {
2136
+ * // request body parameters
2137
+ * // {
2138
+ * // "displayName": "my_displayName",
2139
+ * // "historyId": "my_historyId",
2140
+ * // "name": "my_name",
2141
+ * // "testPlatform": "my_testPlatform"
2142
+ * // }
2143
+ * },
2144
+ * });
2145
+ * console.log(res.data);
2146
+ *
2147
+ * // Example response
2148
+ * // {
2149
+ * // "displayName": "my_displayName",
2150
+ * // "historyId": "my_historyId",
2151
+ * // "name": "my_name",
2152
+ * // "testPlatform": "my_testPlatform"
2153
+ * // }
2154
+ * }
2155
+ *
2156
+ * main().catch(e => {
2157
+ * console.error(e);
2158
+ * throw e;
2159
+ * });
2160
+ *
2161
+ * ```
2006
2162
  *
2007
2163
  * @param params - Parameters for request
2008
2164
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2093,6 +2249,57 @@ export namespace toolresults_v1beta3 {
2093
2249
 
2094
2250
  /**
2095
2251
  * 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
2252
+ * @example
2253
+ * ```js
2254
+ * // Before running the sample:
2255
+ * // - Enable the API at:
2256
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2257
+ * // - Login into gcloud by running:
2258
+ * // ```sh
2259
+ * // $ gcloud auth application-default login
2260
+ * // ```
2261
+ * // - Install the npm module by running:
2262
+ * // ```sh
2263
+ * // $ npm install googleapis
2264
+ * // ```
2265
+ *
2266
+ * const {google} = require('googleapis');
2267
+ * const toolresults = google.toolresults('v1beta3');
2268
+ *
2269
+ * async function main() {
2270
+ * const auth = new google.auth.GoogleAuth({
2271
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2272
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2273
+ * });
2274
+ *
2275
+ * // Acquire an auth client, and bind it to all future calls
2276
+ * const authClient = await auth.getClient();
2277
+ * google.options({auth: authClient});
2278
+ *
2279
+ * // Do the magic
2280
+ * const res = await toolresults.projects.histories.get({
2281
+ * // A History id. Required.
2282
+ * historyId: 'placeholder-value',
2283
+ * // A Project id. Required.
2284
+ * projectId: 'placeholder-value',
2285
+ * });
2286
+ * console.log(res.data);
2287
+ *
2288
+ * // Example response
2289
+ * // {
2290
+ * // "displayName": "my_displayName",
2291
+ * // "historyId": "my_historyId",
2292
+ * // "name": "my_name",
2293
+ * // "testPlatform": "my_testPlatform"
2294
+ * // }
2295
+ * }
2296
+ *
2297
+ * main().catch(e => {
2298
+ * console.error(e);
2299
+ * throw e;
2300
+ * });
2301
+ *
2302
+ * ```
2096
2303
  *
2097
2304
  * @param params - Parameters for request
2098
2305
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2184,6 +2391,59 @@ export namespace toolresults_v1beta3 {
2184
2391
 
2185
2392
  /**
2186
2393
  * 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
2394
+ * @example
2395
+ * ```js
2396
+ * // Before running the sample:
2397
+ * // - Enable the API at:
2398
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2399
+ * // - Login into gcloud by running:
2400
+ * // ```sh
2401
+ * // $ gcloud auth application-default login
2402
+ * // ```
2403
+ * // - Install the npm module by running:
2404
+ * // ```sh
2405
+ * // $ npm install googleapis
2406
+ * // ```
2407
+ *
2408
+ * const {google} = require('googleapis');
2409
+ * const toolresults = google.toolresults('v1beta3');
2410
+ *
2411
+ * async function main() {
2412
+ * const auth = new google.auth.GoogleAuth({
2413
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2414
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2415
+ * });
2416
+ *
2417
+ * // Acquire an auth client, and bind it to all future calls
2418
+ * const authClient = await auth.getClient();
2419
+ * google.options({auth: authClient});
2420
+ *
2421
+ * // Do the magic
2422
+ * const res = await toolresults.projects.histories.list({
2423
+ * // If set, only return histories with the given name. Optional.
2424
+ * filterByName: 'placeholder-value',
2425
+ * // 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.
2426
+ * pageSize: 'placeholder-value',
2427
+ * // A continuation token to resume the query at the next item. Optional.
2428
+ * pageToken: 'placeholder-value',
2429
+ * // A Project id. Required.
2430
+ * projectId: 'placeholder-value',
2431
+ * });
2432
+ * console.log(res.data);
2433
+ *
2434
+ * // Example response
2435
+ * // {
2436
+ * // "histories": [],
2437
+ * // "nextPageToken": "my_nextPageToken"
2438
+ * // }
2439
+ * }
2440
+ *
2441
+ * main().catch(e => {
2442
+ * console.error(e);
2443
+ * throw e;
2444
+ * });
2445
+ *
2446
+ * ```
2187
2447
  *
2188
2448
  * @param params - Parameters for request
2189
2449
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2341,6 +2601,78 @@ export namespace toolresults_v1beta3 {
2341
2601
 
2342
2602
  /**
2343
2603
  * 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
2604
+ * @example
2605
+ * ```js
2606
+ * // Before running the sample:
2607
+ * // - Enable the API at:
2608
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2609
+ * // - Login into gcloud by running:
2610
+ * // ```sh
2611
+ * // $ gcloud auth application-default login
2612
+ * // ```
2613
+ * // - Install the npm module by running:
2614
+ * // ```sh
2615
+ * // $ npm install googleapis
2616
+ * // ```
2617
+ *
2618
+ * const {google} = require('googleapis');
2619
+ * const toolresults = google.toolresults('v1beta3');
2620
+ *
2621
+ * async function main() {
2622
+ * const auth = new google.auth.GoogleAuth({
2623
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2624
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2625
+ * });
2626
+ *
2627
+ * // Acquire an auth client, and bind it to all future calls
2628
+ * const authClient = await auth.getClient();
2629
+ * google.options({auth: authClient});
2630
+ *
2631
+ * // Do the magic
2632
+ * const res = await toolresults.projects.histories.executions.create({
2633
+ * // A History id. Required.
2634
+ * historyId: 'placeholder-value',
2635
+ * // A Project id. Required.
2636
+ * projectId: 'placeholder-value',
2637
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
2638
+ * requestId: 'placeholder-value',
2639
+ *
2640
+ * // Request body metadata
2641
+ * requestBody: {
2642
+ * // request body parameters
2643
+ * // {
2644
+ * // "completionTime": {},
2645
+ * // "creationTime": {},
2646
+ * // "dimensionDefinitions": [],
2647
+ * // "executionId": "my_executionId",
2648
+ * // "outcome": {},
2649
+ * // "specification": {},
2650
+ * // "state": "my_state",
2651
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2652
+ * // }
2653
+ * },
2654
+ * });
2655
+ * console.log(res.data);
2656
+ *
2657
+ * // Example response
2658
+ * // {
2659
+ * // "completionTime": {},
2660
+ * // "creationTime": {},
2661
+ * // "dimensionDefinitions": [],
2662
+ * // "executionId": "my_executionId",
2663
+ * // "outcome": {},
2664
+ * // "specification": {},
2665
+ * // "state": "my_state",
2666
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2667
+ * // }
2668
+ * }
2669
+ *
2670
+ * main().catch(e => {
2671
+ * console.error(e);
2672
+ * throw e;
2673
+ * });
2674
+ *
2675
+ * ```
2344
2676
  *
2345
2677
  * @param params - Parameters for request
2346
2678
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2432,6 +2764,63 @@ export namespace toolresults_v1beta3 {
2432
2764
 
2433
2765
  /**
2434
2766
  * 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
2767
+ * @example
2768
+ * ```js
2769
+ * // Before running the sample:
2770
+ * // - Enable the API at:
2771
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2772
+ * // - Login into gcloud by running:
2773
+ * // ```sh
2774
+ * // $ gcloud auth application-default login
2775
+ * // ```
2776
+ * // - Install the npm module by running:
2777
+ * // ```sh
2778
+ * // $ npm install googleapis
2779
+ * // ```
2780
+ *
2781
+ * const {google} = require('googleapis');
2782
+ * const toolresults = google.toolresults('v1beta3');
2783
+ *
2784
+ * async function main() {
2785
+ * const auth = new google.auth.GoogleAuth({
2786
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2787
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2788
+ * });
2789
+ *
2790
+ * // Acquire an auth client, and bind it to all future calls
2791
+ * const authClient = await auth.getClient();
2792
+ * google.options({auth: authClient});
2793
+ *
2794
+ * // Do the magic
2795
+ * const res = await toolresults.projects.histories.executions.get({
2796
+ * // An Execution id. Required.
2797
+ * executionId: 'placeholder-value',
2798
+ * // A History id. Required.
2799
+ * historyId: 'placeholder-value',
2800
+ * // A Project id. Required.
2801
+ * projectId: 'placeholder-value',
2802
+ * });
2803
+ * console.log(res.data);
2804
+ *
2805
+ * // Example response
2806
+ * // {
2807
+ * // "completionTime": {},
2808
+ * // "creationTime": {},
2809
+ * // "dimensionDefinitions": [],
2810
+ * // "executionId": "my_executionId",
2811
+ * // "outcome": {},
2812
+ * // "specification": {},
2813
+ * // "state": "my_state",
2814
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
2815
+ * // }
2816
+ * }
2817
+ *
2818
+ * main().catch(e => {
2819
+ * console.error(e);
2820
+ * throw e;
2821
+ * });
2822
+ *
2823
+ * ```
2435
2824
  *
2436
2825
  * @param params - Parameters for request
2437
2826
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2523,6 +2912,59 @@ export namespace toolresults_v1beta3 {
2523
2912
 
2524
2913
  /**
2525
2914
  * 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
2915
+ * @example
2916
+ * ```js
2917
+ * // Before running the sample:
2918
+ * // - Enable the API at:
2919
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
2920
+ * // - Login into gcloud by running:
2921
+ * // ```sh
2922
+ * // $ gcloud auth application-default login
2923
+ * // ```
2924
+ * // - Install the npm module by running:
2925
+ * // ```sh
2926
+ * // $ npm install googleapis
2927
+ * // ```
2928
+ *
2929
+ * const {google} = require('googleapis');
2930
+ * const toolresults = google.toolresults('v1beta3');
2931
+ *
2932
+ * async function main() {
2933
+ * const auth = new google.auth.GoogleAuth({
2934
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
2935
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
2936
+ * });
2937
+ *
2938
+ * // Acquire an auth client, and bind it to all future calls
2939
+ * const authClient = await auth.getClient();
2940
+ * google.options({auth: authClient});
2941
+ *
2942
+ * // Do the magic
2943
+ * const res = await toolresults.projects.histories.executions.list({
2944
+ * // A History id. Required.
2945
+ * historyId: 'placeholder-value',
2946
+ * // 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.
2947
+ * pageSize: 'placeholder-value',
2948
+ * // A continuation token to resume the query at the next item. Optional.
2949
+ * pageToken: 'placeholder-value',
2950
+ * // A Project id. Required.
2951
+ * projectId: 'placeholder-value',
2952
+ * });
2953
+ * console.log(res.data);
2954
+ *
2955
+ * // Example response
2956
+ * // {
2957
+ * // "executions": [],
2958
+ * // "nextPageToken": "my_nextPageToken"
2959
+ * // }
2960
+ * }
2961
+ *
2962
+ * main().catch(e => {
2963
+ * console.error(e);
2964
+ * throw e;
2965
+ * });
2966
+ *
2967
+ * ```
2526
2968
  *
2527
2969
  * @param params - Parameters for request
2528
2970
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2616,6 +3058,80 @@ export namespace toolresults_v1beta3 {
2616
3058
 
2617
3059
  /**
2618
3060
  * 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
3061
+ * @example
3062
+ * ```js
3063
+ * // Before running the sample:
3064
+ * // - Enable the API at:
3065
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3066
+ * // - Login into gcloud by running:
3067
+ * // ```sh
3068
+ * // $ gcloud auth application-default login
3069
+ * // ```
3070
+ * // - Install the npm module by running:
3071
+ * // ```sh
3072
+ * // $ npm install googleapis
3073
+ * // ```
3074
+ *
3075
+ * const {google} = require('googleapis');
3076
+ * const toolresults = google.toolresults('v1beta3');
3077
+ *
3078
+ * async function main() {
3079
+ * const auth = new google.auth.GoogleAuth({
3080
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3081
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3082
+ * });
3083
+ *
3084
+ * // Acquire an auth client, and bind it to all future calls
3085
+ * const authClient = await auth.getClient();
3086
+ * google.options({auth: authClient});
3087
+ *
3088
+ * // Do the magic
3089
+ * const res = await toolresults.projects.histories.executions.patch({
3090
+ * // Required.
3091
+ * executionId: 'placeholder-value',
3092
+ * // Required.
3093
+ * historyId: 'placeholder-value',
3094
+ * // A Project id. Required.
3095
+ * projectId: 'placeholder-value',
3096
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
3097
+ * requestId: 'placeholder-value',
3098
+ *
3099
+ * // Request body metadata
3100
+ * requestBody: {
3101
+ * // request body parameters
3102
+ * // {
3103
+ * // "completionTime": {},
3104
+ * // "creationTime": {},
3105
+ * // "dimensionDefinitions": [],
3106
+ * // "executionId": "my_executionId",
3107
+ * // "outcome": {},
3108
+ * // "specification": {},
3109
+ * // "state": "my_state",
3110
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
3111
+ * // }
3112
+ * },
3113
+ * });
3114
+ * console.log(res.data);
3115
+ *
3116
+ * // Example response
3117
+ * // {
3118
+ * // "completionTime": {},
3119
+ * // "creationTime": {},
3120
+ * // "dimensionDefinitions": [],
3121
+ * // "executionId": "my_executionId",
3122
+ * // "outcome": {},
3123
+ * // "specification": {},
3124
+ * // "state": "my_state",
3125
+ * // "testExecutionMatrixId": "my_testExecutionMatrixId"
3126
+ * // }
3127
+ * }
3128
+ *
3129
+ * main().catch(e => {
3130
+ * console.error(e);
3131
+ * throw e;
3132
+ * });
3133
+ *
3134
+ * ```
2619
3135
  *
2620
3136
  * @param params - Parameters for request
2621
3137
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2793,6 +3309,61 @@ export namespace toolresults_v1beta3 {
2793
3309
 
2794
3310
  /**
2795
3311
  * Retrieves a single screenshot cluster by its ID
3312
+ * @example
3313
+ * ```js
3314
+ * // Before running the sample:
3315
+ * // - Enable the API at:
3316
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3317
+ * // - Login into gcloud by running:
3318
+ * // ```sh
3319
+ * // $ gcloud auth application-default login
3320
+ * // ```
3321
+ * // - Install the npm module by running:
3322
+ * // ```sh
3323
+ * // $ npm install googleapis
3324
+ * // ```
3325
+ *
3326
+ * const {google} = require('googleapis');
3327
+ * const toolresults = google.toolresults('v1beta3');
3328
+ *
3329
+ * async function main() {
3330
+ * const auth = new google.auth.GoogleAuth({
3331
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3332
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3333
+ * });
3334
+ *
3335
+ * // Acquire an auth client, and bind it to all future calls
3336
+ * const authClient = await auth.getClient();
3337
+ * google.options({auth: authClient});
3338
+ *
3339
+ * // Do the magic
3340
+ * const res = await toolresults.projects.histories.executions.clusters.get({
3341
+ * // A Cluster id Required.
3342
+ * clusterId: 'placeholder-value',
3343
+ * // An Execution id. Required.
3344
+ * executionId: 'placeholder-value',
3345
+ * // A History id. Required.
3346
+ * historyId: 'placeholder-value',
3347
+ * // A Project id. Required.
3348
+ * projectId: 'placeholder-value',
3349
+ * });
3350
+ * console.log(res.data);
3351
+ *
3352
+ * // Example response
3353
+ * // {
3354
+ * // "activity": "my_activity",
3355
+ * // "clusterId": "my_clusterId",
3356
+ * // "keyScreen": {},
3357
+ * // "screens": []
3358
+ * // }
3359
+ * }
3360
+ *
3361
+ * main().catch(e => {
3362
+ * console.error(e);
3363
+ * throw e;
3364
+ * });
3365
+ *
3366
+ * ```
2796
3367
  *
2797
3368
  * @param params - Parameters for request
2798
3369
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2885,6 +3456,56 @@ export namespace toolresults_v1beta3 {
2885
3456
 
2886
3457
  /**
2887
3458
  * 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.
3459
+ * @example
3460
+ * ```js
3461
+ * // Before running the sample:
3462
+ * // - Enable the API at:
3463
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3464
+ * // - Login into gcloud by running:
3465
+ * // ```sh
3466
+ * // $ gcloud auth application-default login
3467
+ * // ```
3468
+ * // - Install the npm module by running:
3469
+ * // ```sh
3470
+ * // $ npm install googleapis
3471
+ * // ```
3472
+ *
3473
+ * const {google} = require('googleapis');
3474
+ * const toolresults = google.toolresults('v1beta3');
3475
+ *
3476
+ * async function main() {
3477
+ * const auth = new google.auth.GoogleAuth({
3478
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3479
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3480
+ * });
3481
+ *
3482
+ * // Acquire an auth client, and bind it to all future calls
3483
+ * const authClient = await auth.getClient();
3484
+ * google.options({auth: authClient});
3485
+ *
3486
+ * // Do the magic
3487
+ * const res = await toolresults.projects.histories.executions.clusters.list({
3488
+ * // An Execution id. Required.
3489
+ * executionId: 'placeholder-value',
3490
+ * // A History id. Required.
3491
+ * historyId: 'placeholder-value',
3492
+ * // A Project id. Required.
3493
+ * projectId: 'placeholder-value',
3494
+ * });
3495
+ * console.log(res.data);
3496
+ *
3497
+ * // Example response
3498
+ * // {
3499
+ * // "clusters": []
3500
+ * // }
3501
+ * }
3502
+ *
3503
+ * main().catch(e => {
3504
+ * console.error(e);
3505
+ * throw e;
3506
+ * });
3507
+ *
3508
+ * ```
2888
3509
  *
2889
3510
  * @param params - Parameters for request
2890
3511
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3025,6 +3646,68 @@ export namespace toolresults_v1beta3 {
3025
3646
 
3026
3647
  /**
3027
3648
  * 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
3649
+ * @example
3650
+ * ```js
3651
+ * // Before running the sample:
3652
+ * // - Enable the API at:
3653
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3654
+ * // - Login into gcloud by running:
3655
+ * // ```sh
3656
+ * // $ gcloud auth application-default login
3657
+ * // ```
3658
+ * // - Install the npm module by running:
3659
+ * // ```sh
3660
+ * // $ npm install googleapis
3661
+ * // ```
3662
+ *
3663
+ * const {google} = require('googleapis');
3664
+ * const toolresults = google.toolresults('v1beta3');
3665
+ *
3666
+ * async function main() {
3667
+ * const auth = new google.auth.GoogleAuth({
3668
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3669
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3670
+ * });
3671
+ *
3672
+ * // Acquire an auth client, and bind it to all future calls
3673
+ * const authClient = await auth.getClient();
3674
+ * google.options({auth: authClient});
3675
+ *
3676
+ * // Do the magic
3677
+ * const res = await toolresults.projects.histories.executions.environments.get({
3678
+ * // Required. An Environment id.
3679
+ * environmentId: 'placeholder-value',
3680
+ * // Required. An Execution id.
3681
+ * executionId: 'placeholder-value',
3682
+ * // Required. A History id.
3683
+ * historyId: 'placeholder-value',
3684
+ * // Required. A Project id.
3685
+ * projectId: 'placeholder-value',
3686
+ * });
3687
+ * console.log(res.data);
3688
+ *
3689
+ * // Example response
3690
+ * // {
3691
+ * // "completionTime": {},
3692
+ * // "creationTime": {},
3693
+ * // "dimensionValue": [],
3694
+ * // "displayName": "my_displayName",
3695
+ * // "environmentId": "my_environmentId",
3696
+ * // "environmentResult": {},
3697
+ * // "executionId": "my_executionId",
3698
+ * // "historyId": "my_historyId",
3699
+ * // "projectId": "my_projectId",
3700
+ * // "resultsStorage": {},
3701
+ * // "shardSummaries": []
3702
+ * // }
3703
+ * }
3704
+ *
3705
+ * main().catch(e => {
3706
+ * console.error(e);
3707
+ * throw e;
3708
+ * });
3709
+ *
3710
+ * ```
3028
3711
  *
3029
3712
  * @param params - Parameters for request
3030
3713
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3122,6 +3805,66 @@ export namespace toolresults_v1beta3 {
3122
3805
 
3123
3806
  /**
3124
3807
  * 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
3808
+ * @example
3809
+ * ```js
3810
+ * // Before running the sample:
3811
+ * // - Enable the API at:
3812
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
3813
+ * // - Login into gcloud by running:
3814
+ * // ```sh
3815
+ * // $ gcloud auth application-default login
3816
+ * // ```
3817
+ * // - Install the npm module by running:
3818
+ * // ```sh
3819
+ * // $ npm install googleapis
3820
+ * // ```
3821
+ *
3822
+ * const {google} = require('googleapis');
3823
+ * const toolresults = google.toolresults('v1beta3');
3824
+ *
3825
+ * async function main() {
3826
+ * const auth = new google.auth.GoogleAuth({
3827
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
3828
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
3829
+ * });
3830
+ *
3831
+ * // Acquire an auth client, and bind it to all future calls
3832
+ * const authClient = await auth.getClient();
3833
+ * google.options({auth: authClient});
3834
+ *
3835
+ * // Do the magic
3836
+ * const res = await toolresults.projects.histories.executions.environments.list(
3837
+ * {
3838
+ * // Required. An Execution id.
3839
+ * executionId: 'placeholder-value',
3840
+ * // Required. A History id.
3841
+ * historyId: 'placeholder-value',
3842
+ * // 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.
3843
+ * pageSize: 'placeholder-value',
3844
+ * // A continuation token to resume the query at the next item.
3845
+ * pageToken: 'placeholder-value',
3846
+ * // Required. A Project id.
3847
+ * projectId: 'placeholder-value',
3848
+ * },
3849
+ * );
3850
+ * console.log(res.data);
3851
+ *
3852
+ * // Example response
3853
+ * // {
3854
+ * // "environments": [],
3855
+ * // "executionId": "my_executionId",
3856
+ * // "historyId": "my_historyId",
3857
+ * // "nextPageToken": "my_nextPageToken",
3858
+ * // "projectId": "my_projectId"
3859
+ * // }
3860
+ * }
3861
+ *
3862
+ * main().catch(e => {
3863
+ * console.error(e);
3864
+ * throw e;
3865
+ * });
3866
+ *
3867
+ * ```
3125
3868
  *
3126
3869
  * @param params - Parameters for request
3127
3870
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3286,6 +4029,58 @@ export namespace toolresults_v1beta3 {
3286
4029
 
3287
4030
  /**
3288
4031
  * 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
4032
+ * @example
4033
+ * ```js
4034
+ * // Before running the sample:
4035
+ * // - Enable the API at:
4036
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4037
+ * // - Login into gcloud by running:
4038
+ * // ```sh
4039
+ * // $ gcloud auth application-default login
4040
+ * // ```
4041
+ * // - Install the npm module by running:
4042
+ * // ```sh
4043
+ * // $ npm install googleapis
4044
+ * // ```
4045
+ *
4046
+ * const {google} = require('googleapis');
4047
+ * const toolresults = google.toolresults('v1beta3');
4048
+ *
4049
+ * async function main() {
4050
+ * const auth = new google.auth.GoogleAuth({
4051
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4052
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4053
+ * });
4054
+ *
4055
+ * // Acquire an auth client, and bind it to all future calls
4056
+ * const authClient = await auth.getClient();
4057
+ * google.options({auth: authClient});
4058
+ *
4059
+ * // Do the magic
4060
+ * const res =
4061
+ * await toolresults.projects.histories.executions.steps.accessibilityClusters(
4062
+ * {
4063
+ * // 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.
4064
+ * locale: 'placeholder-value',
4065
+ * // A full resource name of the step. For example, projects/my-project/histories/bh.1234567890abcdef/executions/ 1234567890123456789/steps/bs.1234567890abcdef Required.
4066
+ * name: 'projects/my-project/histories/my-historie/executions/my-execution/steps/my-step',
4067
+ * },
4068
+ * );
4069
+ * console.log(res.data);
4070
+ *
4071
+ * // Example response
4072
+ * // {
4073
+ * // "clusters": [],
4074
+ * // "name": "my_name"
4075
+ * // }
4076
+ * }
4077
+ *
4078
+ * main().catch(e => {
4079
+ * console.error(e);
4080
+ * throw e;
4081
+ * });
4082
+ *
4083
+ * ```
3289
4084
  *
3290
4085
  * @param params - Parameters for request
3291
4086
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3387,6 +4182,94 @@ export namespace toolresults_v1beta3 {
3387
4182
 
3388
4183
  /**
3389
4184
  * 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
4185
+ * @example
4186
+ * ```js
4187
+ * // Before running the sample:
4188
+ * // - Enable the API at:
4189
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4190
+ * // - Login into gcloud by running:
4191
+ * // ```sh
4192
+ * // $ gcloud auth application-default login
4193
+ * // ```
4194
+ * // - Install the npm module by running:
4195
+ * // ```sh
4196
+ * // $ npm install googleapis
4197
+ * // ```
4198
+ *
4199
+ * const {google} = require('googleapis');
4200
+ * const toolresults = google.toolresults('v1beta3');
4201
+ *
4202
+ * async function main() {
4203
+ * const auth = new google.auth.GoogleAuth({
4204
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4205
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4206
+ * });
4207
+ *
4208
+ * // Acquire an auth client, and bind it to all future calls
4209
+ * const authClient = await auth.getClient();
4210
+ * google.options({auth: authClient});
4211
+ *
4212
+ * // Do the magic
4213
+ * const res = await toolresults.projects.histories.executions.steps.create({
4214
+ * // Required. An Execution id.
4215
+ * executionId: 'placeholder-value',
4216
+ * // Required. A History id.
4217
+ * historyId: 'placeholder-value',
4218
+ * // Required. A Project id.
4219
+ * projectId: 'placeholder-value',
4220
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
4221
+ * requestId: 'placeholder-value',
4222
+ *
4223
+ * // Request body metadata
4224
+ * requestBody: {
4225
+ * // request body parameters
4226
+ * // {
4227
+ * // "completionTime": {},
4228
+ * // "creationTime": {},
4229
+ * // "description": "my_description",
4230
+ * // "deviceUsageDuration": {},
4231
+ * // "dimensionValue": [],
4232
+ * // "hasImages": false,
4233
+ * // "labels": [],
4234
+ * // "multiStep": {},
4235
+ * // "name": "my_name",
4236
+ * // "outcome": {},
4237
+ * // "runDuration": {},
4238
+ * // "state": "my_state",
4239
+ * // "stepId": "my_stepId",
4240
+ * // "testExecutionStep": {},
4241
+ * // "toolExecutionStep": {}
4242
+ * // }
4243
+ * },
4244
+ * });
4245
+ * console.log(res.data);
4246
+ *
4247
+ * // Example response
4248
+ * // {
4249
+ * // "completionTime": {},
4250
+ * // "creationTime": {},
4251
+ * // "description": "my_description",
4252
+ * // "deviceUsageDuration": {},
4253
+ * // "dimensionValue": [],
4254
+ * // "hasImages": false,
4255
+ * // "labels": [],
4256
+ * // "multiStep": {},
4257
+ * // "name": "my_name",
4258
+ * // "outcome": {},
4259
+ * // "runDuration": {},
4260
+ * // "state": "my_state",
4261
+ * // "stepId": "my_stepId",
4262
+ * // "testExecutionStep": {},
4263
+ * // "toolExecutionStep": {}
4264
+ * // }
4265
+ * }
4266
+ *
4267
+ * main().catch(e => {
4268
+ * console.error(e);
4269
+ * throw e;
4270
+ * });
4271
+ *
4272
+ * ```
3390
4273
  *
3391
4274
  * @param params - Parameters for request
3392
4275
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3479,6 +4362,72 @@ export namespace toolresults_v1beta3 {
3479
4362
 
3480
4363
  /**
3481
4364
  * 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
4365
+ * @example
4366
+ * ```js
4367
+ * // Before running the sample:
4368
+ * // - Enable the API at:
4369
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4370
+ * // - Login into gcloud by running:
4371
+ * // ```sh
4372
+ * // $ gcloud auth application-default login
4373
+ * // ```
4374
+ * // - Install the npm module by running:
4375
+ * // ```sh
4376
+ * // $ npm install googleapis
4377
+ * // ```
4378
+ *
4379
+ * const {google} = require('googleapis');
4380
+ * const toolresults = google.toolresults('v1beta3');
4381
+ *
4382
+ * async function main() {
4383
+ * const auth = new google.auth.GoogleAuth({
4384
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4385
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4386
+ * });
4387
+ *
4388
+ * // Acquire an auth client, and bind it to all future calls
4389
+ * const authClient = await auth.getClient();
4390
+ * google.options({auth: authClient});
4391
+ *
4392
+ * // Do the magic
4393
+ * const res = await toolresults.projects.histories.executions.steps.get({
4394
+ * // A Execution id. Required.
4395
+ * executionId: 'placeholder-value',
4396
+ * // A History id. Required.
4397
+ * historyId: 'placeholder-value',
4398
+ * // A Project id. Required.
4399
+ * projectId: 'placeholder-value',
4400
+ * // A Step id. Required.
4401
+ * stepId: 'placeholder-value',
4402
+ * });
4403
+ * console.log(res.data);
4404
+ *
4405
+ * // Example response
4406
+ * // {
4407
+ * // "completionTime": {},
4408
+ * // "creationTime": {},
4409
+ * // "description": "my_description",
4410
+ * // "deviceUsageDuration": {},
4411
+ * // "dimensionValue": [],
4412
+ * // "hasImages": false,
4413
+ * // "labels": [],
4414
+ * // "multiStep": {},
4415
+ * // "name": "my_name",
4416
+ * // "outcome": {},
4417
+ * // "runDuration": {},
4418
+ * // "state": "my_state",
4419
+ * // "stepId": "my_stepId",
4420
+ * // "testExecutionStep": {},
4421
+ * // "toolExecutionStep": {}
4422
+ * // }
4423
+ * }
4424
+ *
4425
+ * main().catch(e => {
4426
+ * console.error(e);
4427
+ * throw e;
4428
+ * });
4429
+ *
4430
+ * ```
3482
4431
  *
3483
4432
  * @param params - Parameters for request
3484
4433
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3570,6 +4519,68 @@ export namespace toolresults_v1beta3 {
3570
4519
 
3571
4520
  /**
3572
4521
  * Retrieves a PerfMetricsSummary. May return any of the following error code(s): - NOT_FOUND - The specified PerfMetricsSummary does not exist
4522
+ * @example
4523
+ * ```js
4524
+ * // Before running the sample:
4525
+ * // - Enable the API at:
4526
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4527
+ * // - Login into gcloud by running:
4528
+ * // ```sh
4529
+ * // $ gcloud auth application-default login
4530
+ * // ```
4531
+ * // - Install the npm module by running:
4532
+ * // ```sh
4533
+ * // $ npm install googleapis
4534
+ * // ```
4535
+ *
4536
+ * const {google} = require('googleapis');
4537
+ * const toolresults = google.toolresults('v1beta3');
4538
+ *
4539
+ * async function main() {
4540
+ * const auth = new google.auth.GoogleAuth({
4541
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4542
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4543
+ * });
4544
+ *
4545
+ * // Acquire an auth client, and bind it to all future calls
4546
+ * const authClient = await auth.getClient();
4547
+ * google.options({auth: authClient});
4548
+ *
4549
+ * // Do the magic
4550
+ * const res =
4551
+ * await toolresults.projects.histories.executions.steps.getPerfMetricsSummary(
4552
+ * {
4553
+ * // A tool results execution ID.
4554
+ * executionId: 'placeholder-value',
4555
+ * // A tool results history ID.
4556
+ * historyId: 'placeholder-value',
4557
+ * // The cloud project
4558
+ * projectId: 'placeholder-value',
4559
+ * // A tool results step ID.
4560
+ * stepId: 'placeholder-value',
4561
+ * },
4562
+ * );
4563
+ * console.log(res.data);
4564
+ *
4565
+ * // Example response
4566
+ * // {
4567
+ * // "appStartTime": {},
4568
+ * // "executionId": "my_executionId",
4569
+ * // "graphicsStats": {},
4570
+ * // "historyId": "my_historyId",
4571
+ * // "perfEnvironment": {},
4572
+ * // "perfMetrics": [],
4573
+ * // "projectId": "my_projectId",
4574
+ * // "stepId": "my_stepId"
4575
+ * // }
4576
+ * }
4577
+ *
4578
+ * main().catch(e => {
4579
+ * console.error(e);
4580
+ * throw e;
4581
+ * });
4582
+ *
4583
+ * ```
3573
4584
  *
3574
4585
  * @param params - Parameters for request
3575
4586
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3664,6 +4675,61 @@ export namespace toolresults_v1beta3 {
3664
4675
 
3665
4676
  /**
3666
4677
  * 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
4678
+ * @example
4679
+ * ```js
4680
+ * // Before running the sample:
4681
+ * // - Enable the API at:
4682
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4683
+ * // - Login into gcloud by running:
4684
+ * // ```sh
4685
+ * // $ gcloud auth application-default login
4686
+ * // ```
4687
+ * // - Install the npm module by running:
4688
+ * // ```sh
4689
+ * // $ npm install googleapis
4690
+ * // ```
4691
+ *
4692
+ * const {google} = require('googleapis');
4693
+ * const toolresults = google.toolresults('v1beta3');
4694
+ *
4695
+ * async function main() {
4696
+ * const auth = new google.auth.GoogleAuth({
4697
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4698
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4699
+ * });
4700
+ *
4701
+ * // Acquire an auth client, and bind it to all future calls
4702
+ * const authClient = await auth.getClient();
4703
+ * google.options({auth: authClient});
4704
+ *
4705
+ * // Do the magic
4706
+ * const res = await toolresults.projects.histories.executions.steps.list({
4707
+ * // A Execution id. Required.
4708
+ * executionId: 'placeholder-value',
4709
+ * // A History id. Required.
4710
+ * historyId: 'placeholder-value',
4711
+ * // 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.
4712
+ * pageSize: 'placeholder-value',
4713
+ * // A continuation token to resume the query at the next item. Optional.
4714
+ * pageToken: 'placeholder-value',
4715
+ * // A Project id. Required.
4716
+ * projectId: 'placeholder-value',
4717
+ * });
4718
+ * console.log(res.data);
4719
+ *
4720
+ * // Example response
4721
+ * // {
4722
+ * // "nextPageToken": "my_nextPageToken",
4723
+ * // "steps": []
4724
+ * // }
4725
+ * }
4726
+ *
4727
+ * main().catch(e => {
4728
+ * console.error(e);
4729
+ * throw e;
4730
+ * });
4731
+ *
4732
+ * ```
3667
4733
  *
3668
4734
  * @param params - Parameters for request
3669
4735
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3755,6 +4821,96 @@ export namespace toolresults_v1beta3 {
3755
4821
 
3756
4822
  /**
3757
4823
  * 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
4824
+ * @example
4825
+ * ```js
4826
+ * // Before running the sample:
4827
+ * // - Enable the API at:
4828
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
4829
+ * // - Login into gcloud by running:
4830
+ * // ```sh
4831
+ * // $ gcloud auth application-default login
4832
+ * // ```
4833
+ * // - Install the npm module by running:
4834
+ * // ```sh
4835
+ * // $ npm install googleapis
4836
+ * // ```
4837
+ *
4838
+ * const {google} = require('googleapis');
4839
+ * const toolresults = google.toolresults('v1beta3');
4840
+ *
4841
+ * async function main() {
4842
+ * const auth = new google.auth.GoogleAuth({
4843
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
4844
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
4845
+ * });
4846
+ *
4847
+ * // Acquire an auth client, and bind it to all future calls
4848
+ * const authClient = await auth.getClient();
4849
+ * google.options({auth: authClient});
4850
+ *
4851
+ * // Do the magic
4852
+ * const res = await toolresults.projects.histories.executions.steps.patch({
4853
+ * // A Execution id. Required.
4854
+ * executionId: 'placeholder-value',
4855
+ * // A History id. Required.
4856
+ * historyId: 'placeholder-value',
4857
+ * // A Project id. Required.
4858
+ * projectId: 'placeholder-value',
4859
+ * // A unique request ID for server to detect duplicated requests. For example, a UUID. Optional, but strongly recommended.
4860
+ * requestId: 'placeholder-value',
4861
+ * // A Step id. Required.
4862
+ * stepId: 'placeholder-value',
4863
+ *
4864
+ * // Request body metadata
4865
+ * requestBody: {
4866
+ * // request body parameters
4867
+ * // {
4868
+ * // "completionTime": {},
4869
+ * // "creationTime": {},
4870
+ * // "description": "my_description",
4871
+ * // "deviceUsageDuration": {},
4872
+ * // "dimensionValue": [],
4873
+ * // "hasImages": false,
4874
+ * // "labels": [],
4875
+ * // "multiStep": {},
4876
+ * // "name": "my_name",
4877
+ * // "outcome": {},
4878
+ * // "runDuration": {},
4879
+ * // "state": "my_state",
4880
+ * // "stepId": "my_stepId",
4881
+ * // "testExecutionStep": {},
4882
+ * // "toolExecutionStep": {}
4883
+ * // }
4884
+ * },
4885
+ * });
4886
+ * console.log(res.data);
4887
+ *
4888
+ * // Example response
4889
+ * // {
4890
+ * // "completionTime": {},
4891
+ * // "creationTime": {},
4892
+ * // "description": "my_description",
4893
+ * // "deviceUsageDuration": {},
4894
+ * // "dimensionValue": [],
4895
+ * // "hasImages": false,
4896
+ * // "labels": [],
4897
+ * // "multiStep": {},
4898
+ * // "name": "my_name",
4899
+ * // "outcome": {},
4900
+ * // "runDuration": {},
4901
+ * // "state": "my_state",
4902
+ * // "stepId": "my_stepId",
4903
+ * // "testExecutionStep": {},
4904
+ * // "toolExecutionStep": {}
4905
+ * // }
4906
+ * }
4907
+ *
4908
+ * main().catch(e => {
4909
+ * console.error(e);
4910
+ * throw e;
4911
+ * });
4912
+ *
4913
+ * ```
3758
4914
  *
3759
4915
  * @param params - Parameters for request
3760
4916
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3847,6 +5003,81 @@ export namespace toolresults_v1beta3 {
3847
5003
 
3848
5004
  /**
3849
5005
  * 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
5006
+ * @example
5007
+ * ```js
5008
+ * // Before running the sample:
5009
+ * // - Enable the API at:
5010
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
5011
+ * // - Login into gcloud by running:
5012
+ * // ```sh
5013
+ * // $ gcloud auth application-default login
5014
+ * // ```
5015
+ * // - Install the npm module by running:
5016
+ * // ```sh
5017
+ * // $ npm install googleapis
5018
+ * // ```
5019
+ *
5020
+ * const {google} = require('googleapis');
5021
+ * const toolresults = google.toolresults('v1beta3');
5022
+ *
5023
+ * async function main() {
5024
+ * const auth = new google.auth.GoogleAuth({
5025
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5026
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5027
+ * });
5028
+ *
5029
+ * // Acquire an auth client, and bind it to all future calls
5030
+ * const authClient = await auth.getClient();
5031
+ * google.options({auth: authClient});
5032
+ *
5033
+ * // Do the magic
5034
+ * const res =
5035
+ * await toolresults.projects.histories.executions.steps.publishXunitXmlFiles({
5036
+ * // A Execution id. Required.
5037
+ * executionId: 'placeholder-value',
5038
+ * // A History id. Required.
5039
+ * historyId: 'placeholder-value',
5040
+ * // A Project id. Required.
5041
+ * projectId: 'placeholder-value',
5042
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
5043
+ * stepId: 'placeholder-value',
5044
+ *
5045
+ * // Request body metadata
5046
+ * requestBody: {
5047
+ * // request body parameters
5048
+ * // {
5049
+ * // "xunitXmlFiles": []
5050
+ * // }
5051
+ * },
5052
+ * });
5053
+ * console.log(res.data);
5054
+ *
5055
+ * // Example response
5056
+ * // {
5057
+ * // "completionTime": {},
5058
+ * // "creationTime": {},
5059
+ * // "description": "my_description",
5060
+ * // "deviceUsageDuration": {},
5061
+ * // "dimensionValue": [],
5062
+ * // "hasImages": false,
5063
+ * // "labels": [],
5064
+ * // "multiStep": {},
5065
+ * // "name": "my_name",
5066
+ * // "outcome": {},
5067
+ * // "runDuration": {},
5068
+ * // "state": "my_state",
5069
+ * // "stepId": "my_stepId",
5070
+ * // "testExecutionStep": {},
5071
+ * // "toolExecutionStep": {}
5072
+ * // }
5073
+ * }
5074
+ *
5075
+ * main().catch(e => {
5076
+ * console.error(e);
5077
+ * throw e;
5078
+ * });
5079
+ *
5080
+ * ```
3850
5081
  *
3851
5082
  * @param params - Parameters for request
3852
5083
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4095,6 +5326,83 @@ export namespace toolresults_v1beta3 {
4095
5326
 
4096
5327
  /**
4097
5328
  * 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
5329
+ * @example
5330
+ * ```js
5331
+ * // Before running the sample:
5332
+ * // - Enable the API at:
5333
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
5334
+ * // - Login into gcloud by running:
5335
+ * // ```sh
5336
+ * // $ gcloud auth application-default login
5337
+ * // ```
5338
+ * // - Install the npm module by running:
5339
+ * // ```sh
5340
+ * // $ npm install googleapis
5341
+ * // ```
5342
+ *
5343
+ * const {google} = require('googleapis');
5344
+ * const toolresults = google.toolresults('v1beta3');
5345
+ *
5346
+ * async function main() {
5347
+ * const auth = new google.auth.GoogleAuth({
5348
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5349
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5350
+ * });
5351
+ *
5352
+ * // Acquire an auth client, and bind it to all future calls
5353
+ * const authClient = await auth.getClient();
5354
+ * google.options({auth: authClient});
5355
+ *
5356
+ * // Do the magic
5357
+ * const res =
5358
+ * await toolresults.projects.histories.executions.steps.perfMetricsSummary.create(
5359
+ * {
5360
+ * // A tool results execution ID.
5361
+ * executionId: 'placeholder-value',
5362
+ * // A tool results history ID.
5363
+ * historyId: 'placeholder-value',
5364
+ * // The cloud project
5365
+ * projectId: 'placeholder-value',
5366
+ * // A tool results step ID.
5367
+ * stepId: 'placeholder-value',
5368
+ *
5369
+ * // Request body metadata
5370
+ * requestBody: {
5371
+ * // request body parameters
5372
+ * // {
5373
+ * // "appStartTime": {},
5374
+ * // "executionId": "my_executionId",
5375
+ * // "graphicsStats": {},
5376
+ * // "historyId": "my_historyId",
5377
+ * // "perfEnvironment": {},
5378
+ * // "perfMetrics": [],
5379
+ * // "projectId": "my_projectId",
5380
+ * // "stepId": "my_stepId"
5381
+ * // }
5382
+ * },
5383
+ * },
5384
+ * );
5385
+ * console.log(res.data);
5386
+ *
5387
+ * // Example response
5388
+ * // {
5389
+ * // "appStartTime": {},
5390
+ * // "executionId": "my_executionId",
5391
+ * // "graphicsStats": {},
5392
+ * // "historyId": "my_historyId",
5393
+ * // "perfEnvironment": {},
5394
+ * // "perfMetrics": [],
5395
+ * // "projectId": "my_projectId",
5396
+ * // "stepId": "my_stepId"
5397
+ * // }
5398
+ * }
5399
+ *
5400
+ * main().catch(e => {
5401
+ * console.error(e);
5402
+ * throw e;
5403
+ * });
5404
+ *
5405
+ * ```
4098
5406
  *
4099
5407
  * @param params - Parameters for request
4100
5408
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4224,6 +5532,79 @@ export namespace toolresults_v1beta3 {
4224
5532
 
4225
5533
  /**
4226
5534
  * 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
5535
+ * @example
5536
+ * ```js
5537
+ * // Before running the sample:
5538
+ * // - Enable the API at:
5539
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
5540
+ * // - Login into gcloud by running:
5541
+ * // ```sh
5542
+ * // $ gcloud auth application-default login
5543
+ * // ```
5544
+ * // - Install the npm module by running:
5545
+ * // ```sh
5546
+ * // $ npm install googleapis
5547
+ * // ```
5548
+ *
5549
+ * const {google} = require('googleapis');
5550
+ * const toolresults = google.toolresults('v1beta3');
5551
+ *
5552
+ * async function main() {
5553
+ * const auth = new google.auth.GoogleAuth({
5554
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5555
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5556
+ * });
5557
+ *
5558
+ * // Acquire an auth client, and bind it to all future calls
5559
+ * const authClient = await auth.getClient();
5560
+ * google.options({auth: authClient});
5561
+ *
5562
+ * // Do the magic
5563
+ * const res =
5564
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.create(
5565
+ * {
5566
+ * // A tool results execution ID.
5567
+ * executionId: 'placeholder-value',
5568
+ * // A tool results history ID.
5569
+ * historyId: 'placeholder-value',
5570
+ * // The cloud project
5571
+ * projectId: 'placeholder-value',
5572
+ * // A tool results step ID.
5573
+ * stepId: 'placeholder-value',
5574
+ *
5575
+ * // Request body metadata
5576
+ * requestBody: {
5577
+ * // request body parameters
5578
+ * // {
5579
+ * // "basicPerfSampleSeries": {},
5580
+ * // "executionId": "my_executionId",
5581
+ * // "historyId": "my_historyId",
5582
+ * // "projectId": "my_projectId",
5583
+ * // "sampleSeriesId": "my_sampleSeriesId",
5584
+ * // "stepId": "my_stepId"
5585
+ * // }
5586
+ * },
5587
+ * },
5588
+ * );
5589
+ * console.log(res.data);
5590
+ *
5591
+ * // Example response
5592
+ * // {
5593
+ * // "basicPerfSampleSeries": {},
5594
+ * // "executionId": "my_executionId",
5595
+ * // "historyId": "my_historyId",
5596
+ * // "projectId": "my_projectId",
5597
+ * // "sampleSeriesId": "my_sampleSeriesId",
5598
+ * // "stepId": "my_stepId"
5599
+ * // }
5600
+ * }
5601
+ *
5602
+ * main().catch(e => {
5603
+ * console.error(e);
5604
+ * throw e;
5605
+ * });
5606
+ *
5607
+ * ```
4227
5608
  *
4228
5609
  * @param params - Parameters for request
4229
5610
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4316,6 +5697,66 @@ export namespace toolresults_v1beta3 {
4316
5697
 
4317
5698
  /**
4318
5699
  * Gets a PerfSampleSeries. May return any of the following error code(s): - NOT_FOUND - The specified PerfSampleSeries does not exist
5700
+ * @example
5701
+ * ```js
5702
+ * // Before running the sample:
5703
+ * // - Enable the API at:
5704
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
5705
+ * // - Login into gcloud by running:
5706
+ * // ```sh
5707
+ * // $ gcloud auth application-default login
5708
+ * // ```
5709
+ * // - Install the npm module by running:
5710
+ * // ```sh
5711
+ * // $ npm install googleapis
5712
+ * // ```
5713
+ *
5714
+ * const {google} = require('googleapis');
5715
+ * const toolresults = google.toolresults('v1beta3');
5716
+ *
5717
+ * async function main() {
5718
+ * const auth = new google.auth.GoogleAuth({
5719
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5720
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5721
+ * });
5722
+ *
5723
+ * // Acquire an auth client, and bind it to all future calls
5724
+ * const authClient = await auth.getClient();
5725
+ * google.options({auth: authClient});
5726
+ *
5727
+ * // Do the magic
5728
+ * const res =
5729
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.get({
5730
+ * // A tool results execution ID.
5731
+ * executionId: 'placeholder-value',
5732
+ * // A tool results history ID.
5733
+ * historyId: 'placeholder-value',
5734
+ * // The cloud project
5735
+ * projectId: 'placeholder-value',
5736
+ * // A sample series id
5737
+ * sampleSeriesId: 'placeholder-value',
5738
+ * // A tool results step ID.
5739
+ * stepId: 'placeholder-value',
5740
+ * });
5741
+ * console.log(res.data);
5742
+ *
5743
+ * // Example response
5744
+ * // {
5745
+ * // "basicPerfSampleSeries": {},
5746
+ * // "executionId": "my_executionId",
5747
+ * // "historyId": "my_historyId",
5748
+ * // "projectId": "my_projectId",
5749
+ * // "sampleSeriesId": "my_sampleSeriesId",
5750
+ * // "stepId": "my_stepId"
5751
+ * // }
5752
+ * }
5753
+ *
5754
+ * main().catch(e => {
5755
+ * console.error(e);
5756
+ * throw e;
5757
+ * });
5758
+ *
5759
+ * ```
4319
5760
  *
4320
5761
  * @param params - Parameters for request
4321
5762
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4420,6 +5861,63 @@ export namespace toolresults_v1beta3 {
4420
5861
 
4421
5862
  /**
4422
5863
  * 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
5864
+ * @example
5865
+ * ```js
5866
+ * // Before running the sample:
5867
+ * // - Enable the API at:
5868
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
5869
+ * // - Login into gcloud by running:
5870
+ * // ```sh
5871
+ * // $ gcloud auth application-default login
5872
+ * // ```
5873
+ * // - Install the npm module by running:
5874
+ * // ```sh
5875
+ * // $ npm install googleapis
5876
+ * // ```
5877
+ *
5878
+ * const {google} = require('googleapis');
5879
+ * const toolresults = google.toolresults('v1beta3');
5880
+ *
5881
+ * async function main() {
5882
+ * const auth = new google.auth.GoogleAuth({
5883
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5884
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
5885
+ * });
5886
+ *
5887
+ * // Acquire an auth client, and bind it to all future calls
5888
+ * const authClient = await auth.getClient();
5889
+ * google.options({auth: authClient});
5890
+ *
5891
+ * // Do the magic
5892
+ * const res =
5893
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.list(
5894
+ * {
5895
+ * // A tool results execution ID.
5896
+ * executionId: 'placeholder-value',
5897
+ * // Specify one or more PerfMetricType values such as CPU to filter the result
5898
+ * filter: 'placeholder-value',
5899
+ * // A tool results history ID.
5900
+ * historyId: 'placeholder-value',
5901
+ * // The cloud project
5902
+ * projectId: 'placeholder-value',
5903
+ * // A tool results step ID.
5904
+ * stepId: 'placeholder-value',
5905
+ * },
5906
+ * );
5907
+ * console.log(res.data);
5908
+ *
5909
+ * // Example response
5910
+ * // {
5911
+ * // "perfSampleSeries": []
5912
+ * // }
5913
+ * }
5914
+ *
5915
+ * main().catch(e => {
5916
+ * console.error(e);
5917
+ * throw e;
5918
+ * });
5919
+ *
5920
+ * ```
4423
5921
  *
4424
5922
  * @param params - Parameters for request
4425
5923
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4596,6 +6094,71 @@ export namespace toolresults_v1beta3 {
4596
6094
 
4597
6095
  /**
4598
6096
  * 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
6097
+ * @example
6098
+ * ```js
6099
+ * // Before running the sample:
6100
+ * // - Enable the API at:
6101
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
6102
+ * // - Login into gcloud by running:
6103
+ * // ```sh
6104
+ * // $ gcloud auth application-default login
6105
+ * // ```
6106
+ * // - Install the npm module by running:
6107
+ * // ```sh
6108
+ * // $ npm install googleapis
6109
+ * // ```
6110
+ *
6111
+ * const {google} = require('googleapis');
6112
+ * const toolresults = google.toolresults('v1beta3');
6113
+ *
6114
+ * async function main() {
6115
+ * const auth = new google.auth.GoogleAuth({
6116
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6117
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6118
+ * });
6119
+ *
6120
+ * // Acquire an auth client, and bind it to all future calls
6121
+ * const authClient = await auth.getClient();
6122
+ * google.options({auth: authClient});
6123
+ *
6124
+ * // Do the magic
6125
+ * const res =
6126
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.samples.batchCreate(
6127
+ * {
6128
+ * // A tool results execution ID.
6129
+ * executionId: 'placeholder-value',
6130
+ * // A tool results history ID.
6131
+ * historyId: 'placeholder-value',
6132
+ * // The cloud project
6133
+ * projectId: 'placeholder-value',
6134
+ * // A sample series id
6135
+ * sampleSeriesId: 'placeholder-value',
6136
+ * // A tool results step ID.
6137
+ * stepId: 'placeholder-value',
6138
+ *
6139
+ * // Request body metadata
6140
+ * requestBody: {
6141
+ * // request body parameters
6142
+ * // {
6143
+ * // "perfSamples": []
6144
+ * // }
6145
+ * },
6146
+ * },
6147
+ * );
6148
+ * console.log(res.data);
6149
+ *
6150
+ * // Example response
6151
+ * // {
6152
+ * // "perfSamples": []
6153
+ * // }
6154
+ * }
6155
+ *
6156
+ * main().catch(e => {
6157
+ * console.error(e);
6158
+ * throw e;
6159
+ * });
6160
+ *
6161
+ * ```
4599
6162
  *
4600
6163
  * @param params - Parameters for request
4601
6164
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4706,6 +6269,68 @@ export namespace toolresults_v1beta3 {
4706
6269
 
4707
6270
  /**
4708
6271
  * 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
6272
+ * @example
6273
+ * ```js
6274
+ * // Before running the sample:
6275
+ * // - Enable the API at:
6276
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
6277
+ * // - Login into gcloud by running:
6278
+ * // ```sh
6279
+ * // $ gcloud auth application-default login
6280
+ * // ```
6281
+ * // - Install the npm module by running:
6282
+ * // ```sh
6283
+ * // $ npm install googleapis
6284
+ * // ```
6285
+ *
6286
+ * const {google} = require('googleapis');
6287
+ * const toolresults = google.toolresults('v1beta3');
6288
+ *
6289
+ * async function main() {
6290
+ * const auth = new google.auth.GoogleAuth({
6291
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6292
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6293
+ * });
6294
+ *
6295
+ * // Acquire an auth client, and bind it to all future calls
6296
+ * const authClient = await auth.getClient();
6297
+ * google.options({auth: authClient});
6298
+ *
6299
+ * // Do the magic
6300
+ * const res =
6301
+ * await toolresults.projects.histories.executions.steps.perfSampleSeries.samples.list(
6302
+ * {
6303
+ * // A tool results execution ID.
6304
+ * executionId: 'placeholder-value',
6305
+ * // A tool results history ID.
6306
+ * historyId: 'placeholder-value',
6307
+ * // 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
6308
+ * pageSize: 'placeholder-value',
6309
+ * // Optional, the next_page_token returned in the previous response
6310
+ * pageToken: 'placeholder-value',
6311
+ * // The cloud project
6312
+ * projectId: 'placeholder-value',
6313
+ * // A sample series id
6314
+ * sampleSeriesId: 'placeholder-value',
6315
+ * // A tool results step ID.
6316
+ * stepId: 'placeholder-value',
6317
+ * },
6318
+ * );
6319
+ * console.log(res.data);
6320
+ *
6321
+ * // Example response
6322
+ * // {
6323
+ * // "nextPageToken": "my_nextPageToken",
6324
+ * // "perfSamples": []
6325
+ * // }
6326
+ * }
6327
+ *
6328
+ * main().catch(e => {
6329
+ * console.error(e);
6330
+ * throw e;
6331
+ * });
6332
+ *
6333
+ * ```
4709
6334
  *
4710
6335
  * @param params - Parameters for request
4711
6336
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4879,6 +6504,69 @@ export namespace toolresults_v1beta3 {
4879
6504
 
4880
6505
  /**
4881
6506
  * 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
6507
+ * @example
6508
+ * ```js
6509
+ * // Before running the sample:
6510
+ * // - Enable the API at:
6511
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
6512
+ * // - Login into gcloud by running:
6513
+ * // ```sh
6514
+ * // $ gcloud auth application-default login
6515
+ * // ```
6516
+ * // - Install the npm module by running:
6517
+ * // ```sh
6518
+ * // $ npm install googleapis
6519
+ * // ```
6520
+ *
6521
+ * const {google} = require('googleapis');
6522
+ * const toolresults = google.toolresults('v1beta3');
6523
+ *
6524
+ * async function main() {
6525
+ * const auth = new google.auth.GoogleAuth({
6526
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6527
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6528
+ * });
6529
+ *
6530
+ * // Acquire an auth client, and bind it to all future calls
6531
+ * const authClient = await auth.getClient();
6532
+ * google.options({auth: authClient});
6533
+ *
6534
+ * // Do the magic
6535
+ * const res =
6536
+ * await toolresults.projects.histories.executions.steps.testCases.get({
6537
+ * // A Execution id Required.
6538
+ * executionId: 'placeholder-value',
6539
+ * // A History id. Required.
6540
+ * historyId: 'placeholder-value',
6541
+ * // A Project id. Required.
6542
+ * projectId: 'placeholder-value',
6543
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
6544
+ * stepId: 'placeholder-value',
6545
+ * // A Test Case id. Required.
6546
+ * testCaseId: 'placeholder-value',
6547
+ * });
6548
+ * console.log(res.data);
6549
+ *
6550
+ * // Example response
6551
+ * // {
6552
+ * // "elapsedTime": {},
6553
+ * // "endTime": {},
6554
+ * // "skippedMessage": "my_skippedMessage",
6555
+ * // "stackTraces": [],
6556
+ * // "startTime": {},
6557
+ * // "status": "my_status",
6558
+ * // "testCaseId": "my_testCaseId",
6559
+ * // "testCaseReference": {},
6560
+ * // "toolOutputs": []
6561
+ * // }
6562
+ * }
6563
+ *
6564
+ * main().catch(e => {
6565
+ * console.error(e);
6566
+ * throw e;
6567
+ * });
6568
+ *
6569
+ * ```
4882
6570
  *
4883
6571
  * @param params - Parameters for request
4884
6572
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4983,6 +6671,64 @@ export namespace toolresults_v1beta3 {
4983
6671
 
4984
6672
  /**
4985
6673
  * 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
6674
+ * @example
6675
+ * ```js
6676
+ * // Before running the sample:
6677
+ * // - Enable the API at:
6678
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
6679
+ * // - Login into gcloud by running:
6680
+ * // ```sh
6681
+ * // $ gcloud auth application-default login
6682
+ * // ```
6683
+ * // - Install the npm module by running:
6684
+ * // ```sh
6685
+ * // $ npm install googleapis
6686
+ * // ```
6687
+ *
6688
+ * const {google} = require('googleapis');
6689
+ * const toolresults = google.toolresults('v1beta3');
6690
+ *
6691
+ * async function main() {
6692
+ * const auth = new google.auth.GoogleAuth({
6693
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6694
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6695
+ * });
6696
+ *
6697
+ * // Acquire an auth client, and bind it to all future calls
6698
+ * const authClient = await auth.getClient();
6699
+ * google.options({auth: authClient});
6700
+ *
6701
+ * // Do the magic
6702
+ * const res =
6703
+ * await toolresults.projects.histories.executions.steps.testCases.list({
6704
+ * // A Execution id Required.
6705
+ * executionId: 'placeholder-value',
6706
+ * // A History id. Required.
6707
+ * historyId: 'placeholder-value',
6708
+ * // 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.
6709
+ * pageSize: 'placeholder-value',
6710
+ * // A continuation token to resume the query at the next item. Optional.
6711
+ * pageToken: 'placeholder-value',
6712
+ * // A Project id. Required.
6713
+ * projectId: 'placeholder-value',
6714
+ * // A Step id. Note: This step must include a TestExecutionStep. Required.
6715
+ * stepId: 'placeholder-value',
6716
+ * });
6717
+ * console.log(res.data);
6718
+ *
6719
+ * // Example response
6720
+ * // {
6721
+ * // "nextPageToken": "my_nextPageToken",
6722
+ * // "testCases": []
6723
+ * // }
6724
+ * }
6725
+ *
6726
+ * main().catch(e => {
6727
+ * console.error(e);
6728
+ * throw e;
6729
+ * });
6730
+ *
6731
+ * ```
4986
6732
  *
4987
6733
  * @param params - Parameters for request
4988
6734
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5135,6 +6881,64 @@ export namespace toolresults_v1beta3 {
5135
6881
 
5136
6882
  /**
5137
6883
  * 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
6884
+ * @example
6885
+ * ```js
6886
+ * // Before running the sample:
6887
+ * // - Enable the API at:
6888
+ * // https://console.developers.google.com/apis/api/toolresults.googleapis.com
6889
+ * // - Login into gcloud by running:
6890
+ * // ```sh
6891
+ * // $ gcloud auth application-default login
6892
+ * // ```
6893
+ * // - Install the npm module by running:
6894
+ * // ```sh
6895
+ * // $ npm install googleapis
6896
+ * // ```
6897
+ *
6898
+ * const {google} = require('googleapis');
6899
+ * const toolresults = google.toolresults('v1beta3');
6900
+ *
6901
+ * async function main() {
6902
+ * const auth = new google.auth.GoogleAuth({
6903
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
6904
+ * scopes: ['https://www.googleapis.com/auth/cloud-platform'],
6905
+ * });
6906
+ *
6907
+ * // Acquire an auth client, and bind it to all future calls
6908
+ * const authClient = await auth.getClient();
6909
+ * google.options({auth: authClient});
6910
+ *
6911
+ * // Do the magic
6912
+ * const res =
6913
+ * await toolresults.projects.histories.executions.steps.thumbnails.list({
6914
+ * // An Execution id. Required.
6915
+ * executionId: 'placeholder-value',
6916
+ * // A History id. Required.
6917
+ * historyId: 'placeholder-value',
6918
+ * // 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.
6919
+ * pageSize: 'placeholder-value',
6920
+ * // A continuation token to resume the query at the next item. Optional.
6921
+ * pageToken: 'placeholder-value',
6922
+ * // A Project id. Required.
6923
+ * projectId: 'placeholder-value',
6924
+ * // A Step id. Required.
6925
+ * stepId: 'placeholder-value',
6926
+ * });
6927
+ * console.log(res.data);
6928
+ *
6929
+ * // Example response
6930
+ * // {
6931
+ * // "nextPageToken": "my_nextPageToken",
6932
+ * // "thumbnails": []
6933
+ * // }
6934
+ * }
6935
+ *
6936
+ * main().catch(e => {
6937
+ * console.error(e);
6938
+ * throw e;
6939
+ * });
6940
+ *
6941
+ * ```
5138
6942
  *
5139
6943
  * @param params - Parameters for request
5140
6944
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.