@maxim_mazurok/gapi.client.workloadmanager-v1 0.0.20230308 → 0.0.20230406

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://workloadmanager.googleapis.com/$discovery/rest?version=v1
-// Revision: 20230308
+// Revision: 20230406
 
 /// <reference types="gapi.client" />
 
@@ -45,9 +45,43 @@ declare namespace gapi.client {
             ruleNames?: string[];
             /** Output only. [Output only] The updated rule ids if exist. */
             ruleVersions?: string[];
+            /** crontab format schedule for scheduled evaluation, example: 0 *‍/3 * * * */
+            schedule?: string;
             /** Output only. [Output only] Update time stamp */
             updateTime?: string;
         }
+        interface Execution {
+            /** Output only. [Output only] End time stamp */
+            endTime?: string;
+            /** Output only. [Output only] Evaluation ID */
+            evaluationId?: string;
+            /** Output only. [Output only] Inventory time stamp */
+            inventoryTime?: string;
+            /** Labels as key value pairs */
+            labels?: { [P in string]: string };
+            /** The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution} */
+            name?: string;
+            /** type represent whether the execution executed directly by user or scheduled according evaluation.schedule field. */
+            runType?: string;
+            /** Output only. [Output only] Start time stamp */
+            startTime?: string;
+            /** Output only. [Output only] State */
+            state?: string;
+        }
+        interface ExecutionResult {
+            /** the document url of the rule */
+            documentationUrl?: string;
+            /** the violate resource */
+            resource?: Resource;
+            /** the rule which violate in execution */
+            rule?: string;
+            /** severity of violation */
+            severity?: string;
+            /** the details of violation in result */
+            violationDetails?: ViolationDetails;
+            /** the violation message of an execution */
+            violationMessage?: string;
+        }
         interface GceInstanceFilter {
             /** Service account of compute engine */
             serviceAccounts?: string[];
@@ -68,6 +102,20 @@ declare namespace gapi.client {
             /** Locations that could not be reached. */
             unreachable?: string[];
         }
+        interface ListExecutionResultsResponse {
+            /** The versions from the specified publisher. */
+            executionResults?: ExecutionResult[];
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+        }
+        interface ListExecutionsResponse {
+            /** The list of Execution */
+            executions?: Execution[];
+            /** A token identifying a page of results the server should return. */
+            nextPageToken?: string;
+            /** Locations that could not be reached. */
+            unreachable?: string[];
+        }
         interface ListLocationsResponse {
             /** A list of locations that matches the specified filter in the request. */
             locations?: Location[];
@@ -80,6 +128,18 @@ declare namespace gapi.client {
             /** A list of operations that matches the specified filter in the request. */
             operations?: Operation[];
         }
+        interface ListRulesResponse {
+            /** A token identifying a page of results the server should return. */
+            nextPageToken?: string;
+            /** all rules in response */
+            rules?: Rule[];
+        }
+        interface ListScannedResourcesResponse {
+            /** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
+            nextPageToken?: string;
+            /** All scanned resources in response */
+            scannedResources?: ScannedResource[];
+        }
         interface Location {
             /** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
             displayName?: string;
@@ -133,6 +193,14 @@ declare namespace gapi.client {
             /** Output only. Name of the verb executed by the operation. */
             verb?: string;
         }
+        interface Resource {
+            /** the name of the resource */
+            name?: string;
+            /** the service account accosiate with resource */
+            serviceAccount?: string;
+            /** the type of reresource */
+            type?: string;
+        }
         interface ResourceFilter {
             /** Filter compute engine resource */
             gceInstanceFilter?: GceInstanceFilter;
@@ -149,6 +217,42 @@ declare namespace gapi.client {
             /** State of the resource */
             state?: string;
         }
+        interface Rule {
+            /** descrite rule in plain language */
+            description?: string;
+            /** the name display in UI */
+            displayName?: string;
+            /** the message template for rule */
+            errorMessage?: string;
+            /** rule name */
+            name?: string;
+            /** the primary category */
+            primaryCategory?: string;
+            /** the remediation for the rule */
+            remediation?: string;
+            /** Output only. the version of the rule */
+            revisionId?: string;
+            /** the secondary category */
+            secondaryCategory?: string;
+            /** the severity of the rule */
+            severity?: string;
+            /** the docuement url for the rule */
+            uri?: string;
+        }
+        interface RunEvaluationRequest {
+            /** Required. The resource being created */
+            execution?: Execution;
+            /** Required. Id of the requesting object If auto-generating Id server-side, remove this field and execution_id from the method_signature of Create RPC */
+            executionId?: string;
+            /**
+             * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has
+             * already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the
+             * request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore
+             * the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported
+             * (00000000-0000-0000-0000-000000000000).
+             */
+            requestId?: string;
+        }
         interface SapDiscovery {
             /** An SAP system may run without an application layer. */
             applicationLayer?: SapDiscoveryComponent;
@@ -188,6 +292,8 @@ declare namespace gapi.client {
             relatedResources?: string[];
             /** ComputeInstance, ComputeDisk, VPC, Bare Metal server, etc. */
             resourceKind?: string;
+            /** Indicates whether this is a new, updated, or missing resource. */
+            resourceState?: string;
             /** The type of this resource. */
             resourceType?: string;
             /** URI of the resource, includes project, location, and name. */
@@ -205,6 +311,10 @@ declare namespace gapi.client {
             /** The SAP system that the validation data is from. */
             sapValidationType?: string;
         }
+        interface ScannedResource {
+            /** resource name */
+            resource?: string;
+        }
         interface Status {
             /** The status code, which should be an enum value of google.rpc.Code. */
             code?: number;
@@ -216,6 +326,14 @@ declare namespace gapi.client {
              */
             message?: string;
         }
+        interface ViolationDetails {
+            /** the name of asset */
+            asset?: string;
+            /** observed */
+            observed?: { [P in string]: string };
+            /** the service account associate with resource */
+            serviceAccount?: string;
+        }
         interface WriteInsightRequest {
             /** Required. The metrics data details. */
             insight?: Insight;
@@ -231,6 +349,202 @@ declare namespace gapi.client {
         // tslint:disable-next-line:no-empty-interface
         interface WriteInsightResponse {
         }
+        interface ResultsResource {
+            /** List the running result of a single Execution. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** Filtering results */
+                filter?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
+                pageSize?: number;
+                /** A token identifying a page of results the server should return. */
+                pageToken?: string;
+                /** Required. The execution results. Format: {parent}/evaluations/*‍/executions/*‍/results */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ListExecutionResultsResponse>;
+        }
+        interface ScannedResourcesResource {
+            /** List all scanned resources for a single Execution. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** Filtering results */
+                filter?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Field to sort by. See https://google.aip.dev/132#ordering for more details. */
+                orderBy?: string;
+                /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
+                pageSize?: number;
+                /** A token identifying a page of results the server should return. */
+                pageToken?: string;
+                /** Required. parent for ListScannedResourcesRequest */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** rule name */
+                rule?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ListScannedResourcesResponse>;
+        }
+        interface ExecutionsResource {
+            /** Gets details of a single Execution. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. Name of the resource */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<Execution>;
+            /** Lists Executions in a given project and location. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** Filtering results */
+                filter?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Field to sort by. See https://google.aip.dev/132#ordering for more details. */
+                orderBy?: string;
+                /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
+                pageSize?: number;
+                /** A token identifying a page of results the server should return. */
+                pageToken?: string;
+                /** Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}' */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ListExecutionsResponse>;
+            /** Creates a new Execution in a given project and location. */
+            run(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}' */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: RunEvaluationRequest;
+            }): Request<Operation>;
+            run(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}' */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: RunEvaluationRequest): Request<Operation>;
+            results: ResultsResource;
+            scannedResources: ScannedResourcesResource;
+        }
         interface EvaluationsResource {
             /** Creates a new Evaluation in a given project and location. */
             create(request: {
@@ -370,6 +684,7 @@ declare namespace gapi.client {
                 /** Legacy upload protocol for media (e.g. "media", "multipart"). */
                 uploadType?: string;
             }): Request<ListEvaluationsResponse>;
+            executions: ExecutionsResource;
         }
         interface InsightsResource {
             /** Write the data insights to workload manager data warehouse. */
@@ -582,6 +897,44 @@ declare namespace gapi.client {
                 uploadType?: string;
             }): Request<ListOperationsResponse>;
         }
+        interface RulesResource {
+            /** Lists rules in a given project. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** Filter based on primary_category, secondary_category */
+                filter?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. */
+                pageSize?: number;
+                /** A token identifying a page of results the server should return. */
+                pageToken?: string;
+                /**
+                 * Required. The [project] on which to execute the request. The format is: projects/{project_id}/locations/{location} Currently, the pre-defined rules are global available to all
+                 * projects and all regions
+                 */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ListRulesResponse>;
+        }
         interface LocationsResource {
             /** Gets information about a location. */
             get(request?: {
@@ -649,6 +1002,7 @@ declare namespace gapi.client {
             evaluations: EvaluationsResource;
             insights: InsightsResource;
             operations: OperationsResource;
+            rules: RulesResource;
         }
         interface ProjectsResource {
             locations: LocationsResource;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.workloadmanager-v1",
-  "version": "0.0.20230308",
+  "version": "0.0.20230406",
   "description": "TypeScript typings for Workload Manager API v1",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20230308
+// Revision: 20230406
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -80,6 +80,7 @@ gapi.load('client', async () => {
             ruleVersions: [
                 "Test string"
             ],
+            schedule: "Test string",
             updateTime: "Test string",
         });
         /** Gets details of a single Evaluation. */
@@ -94,6 +95,53 @@ gapi.load('client', async () => {
             pageToken: "Test string",
             parent: "Test string",
         });
+        /** Gets details of a single Execution. */
+        await gapi.client.workloadmanager.projects.locations.evaluations.executions.get({
+            name: "Test string",
+        });
+        /** Lists Executions in a given project and location. */
+        await gapi.client.workloadmanager.projects.locations.evaluations.executions.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Creates a new Execution in a given project and location. */
+        await gapi.client.workloadmanager.projects.locations.evaluations.executions.run({
+            name: "Test string",
+        }, {
+            execution: {
+                endTime: "Test string",
+                evaluationId: "Test string",
+                inventoryTime: "Test string",
+                labels: {
+                    A: "Test string"
+                },
+                name: "Test string",
+                runType: "Test string",
+                startTime: "Test string",
+                state: "Test string",
+            },
+            executionId: "Test string",
+            requestId: "Test string",
+        });
+        /** List the running result of a single Execution. */
+        await gapi.client.workloadmanager.projects.locations.evaluations.executions.results.list({
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** List all scanned resources for a single Execution. */
+        await gapi.client.workloadmanager.projects.locations.evaluations.executions.scannedResources.list({
+            filter: "Test string",
+            orderBy: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+            rule: "Test string",
+        });
         /** Write the data insights to workload manager data warehouse. */
         await gapi.client.workloadmanager.projects.locations.insights.writeInsight({
             location: "Test string",
@@ -110,6 +158,7 @@ gapi.load('client', async () => {
                                     "Test string"
                                 ],
                                 resourceKind: "Test string",
+                                resourceState: "Test string",
                                 resourceType: "Test string",
                                 resourceUri: "Test string",
                                 updateTime: "Test string",
@@ -127,6 +176,7 @@ gapi.load('client', async () => {
                                     "Test string"
                                 ],
                                 resourceKind: "Test string",
+                                resourceState: "Test string",
                                 resourceType: "Test string",
                                 resourceUri: "Test string",
                                 updateTime: "Test string",
@@ -185,5 +235,12 @@ gapi.load('client', async () => {
             pageSize: 42,
             pageToken: "Test string",
         });
+        /** Lists rules in a given project. */
+        await gapi.client.workloadmanager.projects.locations.rules.list({
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
     }
 });