google-api-python-client 2.85.0__py2.py3-none-any.whl → 2.87.0__py2.py3-none-any.whl

googleapiclient/discovery_cache/documents/workloadmanager.v1.json

@@ -288,6 +288,213 @@
                     "https://www.googleapis.com/auth/cloud-platform"
                   ]
                 }
+              },
+              "resources": {
+                "executions": {
+                  "methods": {
+                    "get": {
+                      "description": "Gets details of a single Execution.",
+                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}",
+                      "httpMethod": "GET",
+                      "id": "workloadmanager.projects.locations.evaluations.executions.get",
+                      "parameterOrder": [
+                        "name"
+                      ],
+                      "parameters": {
+                        "name": {
+                          "description": "Required. Name of the resource",
+                          "location": "path",
+                          "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$",
+                          "required": true,
+                          "type": "string"
+                        }
+                      },
+                      "path": "v1/{+name}",
+                      "response": {
+                        "$ref": "Execution"
+                      },
+                      "scopes": [
+                        "https://www.googleapis.com/auth/cloud-platform"
+                      ]
+                    },
+                    "list": {
+                      "description": "Lists Executions in a given project and location.",
+                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions",
+                      "httpMethod": "GET",
+                      "id": "workloadmanager.projects.locations.evaluations.executions.list",
+                      "parameterOrder": [
+                        "parent"
+                      ],
+                      "parameters": {
+                        "filter": {
+                          "description": "Filtering results",
+                          "location": "query",
+                          "type": "string"
+                        },
+                        "orderBy": {
+                          "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+                          "location": "query",
+                          "type": "string"
+                        },
+                        "pageSize": {
+                          "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+                          "format": "int32",
+                          "location": "query",
+                          "type": "integer"
+                        },
+                        "pageToken": {
+                          "description": "A token identifying a page of results the server should return.",
+                          "location": "query",
+                          "type": "string"
+                        },
+                        "parent": {
+                          "description": "Required. The resource prefix of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}'",
+                          "location": "path",
+                          "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
+                          "required": true,
+                          "type": "string"
+                        }
+                      },
+                      "path": "v1/{+parent}/executions",
+                      "response": {
+                        "$ref": "ListExecutionsResponse"
+                      },
+                      "scopes": [
+                        "https://www.googleapis.com/auth/cloud-platform"
+                      ]
+                    },
+                    "run": {
+                      "description": "Creates a new Execution in a given project and location.",
+                      "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions:run",
+                      "httpMethod": "POST",
+                      "id": "workloadmanager.projects.locations.evaluations.executions.run",
+                      "parameterOrder": [
+                        "name"
+                      ],
+                      "parameters": {
+                        "name": {
+                          "description": "Required. The resource name of the Execution using the form: 'projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}'",
+                          "location": "path",
+                          "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$",
+                          "required": true,
+                          "type": "string"
+                        }
+                      },
+                      "path": "v1/{+name}/executions:run",
+                      "request": {
+                        "$ref": "RunEvaluationRequest"
+                      },
+                      "response": {
+                        "$ref": "Operation"
+                      },
+                      "scopes": [
+                        "https://www.googleapis.com/auth/cloud-platform"
+                      ]
+                    }
+                  },
+                  "resources": {
+                    "results": {
+                      "methods": {
+                        "list": {
+                          "description": "List the running result of a single Execution.",
+                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/results",
+                          "httpMethod": "GET",
+                          "id": "workloadmanager.projects.locations.evaluations.executions.results.list",
+                          "parameterOrder": [
+                            "parent"
+                          ],
+                          "parameters": {
+                            "filter": {
+                              "description": "Filtering results",
+                              "location": "query",
+                              "type": "string"
+                            },
+                            "pageSize": {
+                              "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+                              "format": "int32",
+                              "location": "query",
+                              "type": "integer"
+                            },
+                            "pageToken": {
+                              "description": "A token identifying a page of results the server should return.",
+                              "location": "query",
+                              "type": "string"
+                            },
+                            "parent": {
+                              "description": "Required. The execution results. Format: {parent}/evaluations/*/executions/*/results",
+                              "location": "path",
+                              "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$",
+                              "required": true,
+                              "type": "string"
+                            }
+                          },
+                          "path": "v1/{+parent}/results",
+                          "response": {
+                            "$ref": "ListExecutionResultsResponse"
+                          },
+                          "scopes": [
+                            "https://www.googleapis.com/auth/cloud-platform"
+                          ]
+                        }
+                      }
+                    },
+                    "scannedResources": {
+                      "methods": {
+                        "list": {
+                          "description": "List all scanned resources for a single Execution.",
+                          "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}/executions/{executionsId}/scannedResources",
+                          "httpMethod": "GET",
+                          "id": "workloadmanager.projects.locations.evaluations.executions.scannedResources.list",
+                          "parameterOrder": [
+                            "parent"
+                          ],
+                          "parameters": {
+                            "filter": {
+                              "description": "Filtering results",
+                              "location": "query",
+                              "type": "string"
+                            },
+                            "orderBy": {
+                              "description": "Field to sort by. See https://google.aip.dev/132#ordering for more details.",
+                              "location": "query",
+                              "type": "string"
+                            },
+                            "pageSize": {
+                              "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+                              "format": "int32",
+                              "location": "query",
+                              "type": "integer"
+                            },
+                            "pageToken": {
+                              "description": "A token identifying a page of results the server should return.",
+                              "location": "query",
+                              "type": "string"
+                            },
+                            "parent": {
+                              "description": "Required. parent for ListScannedResourcesRequest",
+                              "location": "path",
+                              "pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+/executions/[^/]+$",
+                              "required": true,
+                              "type": "string"
+                            },
+                            "rule": {
+                              "description": "rule name",
+                              "location": "query",
+                              "type": "string"
+                            }
+                          },
+                          "path": "v1/{+parent}/scannedResources",
+                          "response": {
+                            "$ref": "ListScannedResourcesResponse"
+                          },
+                          "scopes": [
+                            "https://www.googleapis.com/auth/cloud-platform"
+                          ]
+                        }
+                      }
+                    }
+                  }
+                }
               }
             },
             "insights": {
@@ -444,13 +651,58 @@
                   ]
                 }
               }
+            },
+            "rules": {
+              "methods": {
+                "list": {
+                  "description": "Lists rules in a given project.",
+                  "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/rules",
+                  "httpMethod": "GET",
+                  "id": "workloadmanager.projects.locations.rules.list",
+                  "parameterOrder": [
+                    "parent"
+                  ],
+                  "parameters": {
+                    "filter": {
+                      "description": "Filter based on primary_category, secondary_category",
+                      "location": "query",
+                      "type": "string"
+                    },
+                    "pageSize": {
+                      "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
+                      "format": "int32",
+                      "location": "query",
+                      "type": "integer"
+                    },
+                    "pageToken": {
+                      "description": "A token identifying a page of results the server should return.",
+                      "location": "query",
+                      "type": "string"
+                    },
+                    "parent": {
+                      "description": "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",
+                      "location": "path",
+                      "pattern": "^projects/[^/]+/locations/[^/]+$",
+                      "required": true,
+                      "type": "string"
+                    }
+                  },
+                  "path": "v1/{+parent}/rules",
+                  "response": {
+                    "$ref": "ListRulesResponse"
+                  },
+                  "scopes": [
+                    "https://www.googleapis.com/auth/cloud-platform"
+                  ]
+                }
+              }
             }
           }
         }
       }
     }
   },
-  "revision": "20230308",
+  "revision": "20230503",
   "rootUrl": "https://workloadmanager.googleapis.com/",
   "schemas": {
     "CancelOperationRequest": {
@@ -514,6 +766,10 @@
           "readOnly": true,
           "type": "array"
         },
+        "schedule": {
+          "description": "crontab format schedule for scheduled evaluation, example: 0 */3 * * *",
+          "type": "string"
+        },
         "updateTime": {
           "description": "Output only. [Output only] Update time stamp",
           "format": "google-datetime",
@@ -523,6 +779,109 @@
       },
       "type": "object"
     },
+    "Execution": {
+      "description": "Message describing Execution object",
+      "id": "Execution",
+      "properties": {
+        "endTime": {
+          "description": "Output only. [Output only] End time stamp",
+          "format": "google-datetime",
+          "readOnly": true,
+          "type": "string"
+        },
+        "evaluationId": {
+          "description": "Output only. [Output only] Evaluation ID",
+          "readOnly": true,
+          "type": "string"
+        },
+        "inventoryTime": {
+          "description": "Output only. [Output only] Inventory time stamp",
+          "format": "google-datetime",
+          "readOnly": true,
+          "type": "string"
+        },
+        "labels": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "Labels as key value pairs",
+          "type": "object"
+        },
+        "name": {
+          "description": "The name of execution resource. The format is projects/{project}/locations/{location}/evaluations/{evaluation}/executions/{execution}",
+          "type": "string"
+        },
+        "runType": {
+          "description": "type represent whether the execution executed directly by user or scheduled according evaluation.schedule field.",
+          "enum": [
+            "TYPE_UNSPECIFIED",
+            "ONE_TIME",
+            "SCHEDULED"
+          ],
+          "enumDescriptions": [
+            "type of execution is unspecified",
+            "type of execution is one time",
+            "type of execution is scheduled"
+          ],
+          "type": "string"
+        },
+        "startTime": {
+          "description": "Output only. [Output only] Start time stamp",
+          "format": "google-datetime",
+          "readOnly": true,
+          "type": "string"
+        },
+        "state": {
+          "description": "Output only. [Output only] State",
+          "enum": [
+            "STATE_UNSPECIFIED",
+            "RUNNING",
+            "SUCCEEDED",
+            "FAILED"
+          ],
+          "enumDescriptions": [
+            "state of execution is unspecified",
+            "the execution is running in backend service",
+            "the execution run success",
+            "the execution run failed"
+          ],
+          "readOnly": true,
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "ExecutionResult": {
+      "description": "Message describing the result of an execution",
+      "id": "ExecutionResult",
+      "properties": {
+        "documentationUrl": {
+          "description": "the document url of the rule",
+          "type": "string"
+        },
+        "resource": {
+          "$ref": "Resource",
+          "description": "the violate resource"
+        },
+        "rule": {
+          "description": "the rule which violate in execution",
+          "type": "string"
+        },
+        "severity": {
+          "description": "severity of violation",
+          "type": "string"
+        },
+        "violationDetails": {
+          "$ref": "ViolationDetails",
+          "description": "the details of violation in result"
+        },
+        "violationMessage": {
+          "description": "the violation message of an execution",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "GceInstanceFilter": {
       "description": "Message describing compute engine instance filter",
       "id": "GceInstanceFilter",
@@ -554,6 +913,10 @@
           "format": "google-datetime",
           "readOnly": true,
           "type": "string"
+        },
+        "sqlserverValidation": {
+          "$ref": "SqlserverValidation",
+          "description": "The insights data for the sqlserver workload validation."
         }
       },
       "type": "object"
@@ -583,6 +946,49 @@
       },
       "type": "object"
     },
+    "ListExecutionResultsResponse": {
+      "description": "Message for response of list execution results",
+      "id": "ListExecutionResultsResponse",
+      "properties": {
+        "executionResults": {
+          "description": "The versions from the specified publisher.",
+          "items": {
+            "$ref": "ExecutionResult"
+          },
+          "type": "array"
+        },
+        "nextPageToken": {
+          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "ListExecutionsResponse": {
+      "description": "Message for response to listing Executions",
+      "id": "ListExecutionsResponse",
+      "properties": {
+        "executions": {
+          "description": "The list of Execution",
+          "items": {
+            "$ref": "Execution"
+          },
+          "type": "array"
+        },
+        "nextPageToken": {
+          "description": "A token identifying a page of results the server should return.",
+          "type": "string"
+        },
+        "unreachable": {
+          "description": "Locations that could not be reached.",
+          "items": {
+            "type": "string"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "ListLocationsResponse": {
       "description": "The response message for Locations.ListLocations.",
       "id": "ListLocationsResponse",
@@ -619,8 +1025,44 @@
       },
       "type": "object"
     },
+    "ListRulesResponse": {
+      "description": "Mesesage of response of list rules",
+      "id": "ListRulesResponse",
+      "properties": {
+        "nextPageToken": {
+          "description": "A token identifying a page of results the server should return.",
+          "type": "string"
+        },
+        "rules": {
+          "description": "all rules in response",
+          "items": {
+            "$ref": "Rule"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "ListScannedResourcesResponse": {
+      "description": "Message for response to list scanned resources",
+      "id": "ListScannedResourcesResponse",
+      "properties": {
+        "nextPageToken": {
+          "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
+          "type": "string"
+        },
+        "scannedResources": {
+          "description": "All scanned resources in response",
+          "items": {
+            "$ref": "ScannedResource"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
     "Location": {
-      "description": "A resource that represents Google Cloud Platform location.",
+      "description": "A resource that represents a Google Cloud location.",
       "id": "Location",
       "properties": {
         "displayName": {
@@ -732,6 +1174,25 @@
       },
       "type": "object"
     },
+    "Resource": {
+      "description": "Message represent resource in execution result",
+      "id": "Resource",
+      "properties": {
+        "name": {
+          "description": "the name of the resource",
+          "type": "string"
+        },
+        "serviceAccount": {
+          "description": "the service account accosiate with resource",
+          "type": "string"
+        },
+        "type": {
+          "description": "the type of reresource",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "ResourceFilter": {
       "description": "Message describing resource filters",
       "id": "ResourceFilter",
@@ -794,6 +1255,73 @@
       },
       "type": "object"
     },
+    "Rule": {
+      "description": "Message represent a rule",
+      "id": "Rule",
+      "properties": {
+        "description": {
+          "description": "descrite rule in plain language",
+          "type": "string"
+        },
+        "displayName": {
+          "description": "the name display in UI",
+          "type": "string"
+        },
+        "errorMessage": {
+          "description": "the message template for rule",
+          "type": "string"
+        },
+        "name": {
+          "description": "rule name",
+          "type": "string"
+        },
+        "primaryCategory": {
+          "description": "the primary category",
+          "type": "string"
+        },
+        "remediation": {
+          "description": "the remediation for the rule",
+          "type": "string"
+        },
+        "revisionId": {
+          "description": "Output only. the version of the rule",
+          "readOnly": true,
+          "type": "string"
+        },
+        "secondaryCategory": {
+          "description": "the secondary category",
+          "type": "string"
+        },
+        "severity": {
+          "description": "the severity of the rule",
+          "type": "string"
+        },
+        "uri": {
+          "description": "the docuement url for the rule",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "RunEvaluationRequest": {
+      "description": "Message for creating a Execution",
+      "id": "RunEvaluationRequest",
+      "properties": {
+        "execution": {
+          "$ref": "Execution",
+          "description": "Required. The resource being created"
+        },
+        "executionId": {
+          "description": "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",
+          "type": "string"
+        },
+        "requestId": {
+          "description": "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).",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "SapDiscovery": {
       "description": "The schema of SAP system discovery data.",
       "id": "SapDiscovery",
@@ -966,6 +1494,67 @@
       },
       "type": "object"
     },
+    "ScannedResource": {
+      "description": "Message of scanned resource",
+      "id": "ScannedResource",
+      "properties": {
+        "resource": {
+          "description": "resource name",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
+    "SqlserverValidation": {
+      "description": "A presentation of SQLServer workload insight. The schema of SqlServer workloads validation related data.",
+      "id": "SqlserverValidation",
+      "properties": {
+        "agentVersion": {
+          "description": "The agent version collected this data point",
+          "type": "string"
+        },
+        "validationDetails": {
+          "description": "A list of SqlServer validation metrics data.",
+          "items": {
+            "$ref": "SqlserverValidationValidationDetail"
+          },
+          "type": "array"
+        }
+      },
+      "type": "object"
+    },
+    "SqlserverValidationValidationDetail": {
+      "description": "Message describing the Sqlserver validation metrics.",
+      "id": "SqlserverValidationValidationDetail",
+      "properties": {
+        "details": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "The pairs of metrics data: field name & field value.",
+          "type": "object"
+        },
+        "instanceId": {
+          "description": "The instance id where the ValidationDetail is generated from",
+          "type": "string"
+        },
+        "type": {
+          "description": "The Sqlserver system that the validation data is from.",
+          "enum": [
+            "SQLSERVER_VALIDATION_TYPE_UNSPECIFIED",
+            "OS",
+            "DB"
+          ],
+          "enumDescriptions": [
+            "Unspecified type.",
+            "The Sqlserver system named OS",
+            "The Sqlserver system named DB"
+          ],
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "Status": {
       "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
       "id": "Status",
@@ -993,6 +1582,28 @@
       },
       "type": "object"
     },
+    "ViolationDetails": {
+      "description": "Message describing the violdation in execution result",
+      "id": "ViolationDetails",
+      "properties": {
+        "asset": {
+          "description": "the name of asset",
+          "type": "string"
+        },
+        "observed": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "description": "observed",
+          "type": "object"
+        },
+        "serviceAccount": {
+          "description": "the service account associate with resource",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "WriteInsightRequest": {
       "description": "Request for sending the data insights.",
       "id": "WriteInsightRequest",